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 /** 30 * @file 31 * This file includes parser definition for RESTful HTTP server. 32 */ 33 34 #ifndef OTBR_REST_PARSER_HPP_ 35 #define OTBR_REST_PARSER_HPP_ 36 37 #include "openthread-br/config.h" 38 39 #include <memory> 40 41 #include "rest/types.hpp" 42 43 extern "C" { 44 #include <http_parser.h> 45 } 46 47 #include "rest/request.hpp" 48 49 namespace otbr { 50 namespace rest { 51 52 /** 53 * This class implements Parser class in OTBR-REST which is used to parse the data from read buffer and form a request. 54 */ 55 class Parser 56 { 57 public: 58 /** 59 * The constructor of a http request parser instance. 60 * 61 * @param[in] aRequest A pointer to a request instance. 62 */ 63 Parser(Request *aRequest); 64 65 /** 66 * This method initializea the http-parser. 67 */ 68 void Init(void); 69 70 /** 71 * This method performs a parse process. 72 * 73 * @param[in] aBuf A pointer pointing to read buffer. 74 * @param[in] aLength An integer indicates how much data is to be processed by parser. 75 */ 76 void Process(const char *aBuf, size_t aLength); 77 78 private: 79 http_parser mParser; 80 http_parser_settings mSettings; 81 }; 82 83 } // namespace rest 84 } // namespace otbr 85 86 #endif // OTBR_REST_PARSER_HPP_ 87