1 /* 2 * Copyright (c) 2020, The OpenThread Authors. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 3. Neither the name of the copyright holder nor the 13 * names of its contributors may be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 #ifndef OT_LIB_URL_URL_HPP_ 30 #define OT_LIB_URL_URL_HPP_ 31 32 #include <openthread/error.h> 33 34 /** 35 * @struct otUrl 36 * 37 * This structure represents a URL. 38 * 39 */ 40 struct otUrl 41 { 42 const char *mProtocol; ///< The URL protocol. 43 const char *mPath; ///< The path. 44 const char *mQuery; ///< The start of the URL query string. 45 const char *mEnd; ///< The end of the URL buffer. 46 }; 47 48 namespace ot { 49 namespace Url { 50 51 /** 52 * This class implements the URL processing. 53 * 54 */ 55 class Url : public otUrl 56 { 57 public: 58 /** 59 * This method initializes the URL. 60 * 61 * @param[in] aUrl A buffer stores the null-terminated URL string. 62 * 63 * @retval OT_ERROR_NONE Successfully parsed the URL. 64 * @retval OT_ERROR_PARSE Failed to parse the string as a URL. 65 * 66 */ 67 otError Init(char *aUrl); 68 69 /** 70 * This method gets the path in URL. 71 * 72 * @returns The path in URL. 73 * 74 */ GetPath(void) const75 const char *GetPath(void) const { return mPath; } 76 77 /** 78 * This method gets the value of parameter @p aName. 79 * 80 * @param[in] aName The parameter name. 81 * @param[in] aLastValue The last iterated parameter value, nullptr for the first value. 82 * 83 * @returns The parameter value. 84 * 85 */ 86 const char *GetValue(const char *aName, const char *aLastValue = nullptr) const; 87 88 /** 89 * This method returns the URL protocol. 90 * 91 * @returns The URL protocol. 92 * 93 */ GetProtocol(void) const94 const char *GetProtocol(void) const { return mProtocol; } 95 }; 96 97 } // namespace Url 98 } // namespace ot 99 100 #endif // OT_LIB_URL_URL_HPP_ 101