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 connection definition for RESTful HTTP server. 32 */ 33 34 #ifndef OTBR_REST_CONNECTION_HPP_ 35 #define OTBR_REST_CONNECTION_HPP_ 36 37 #include "openthread-br/config.h" 38 39 #include <string.h> 40 #include <unistd.h> 41 42 #include "common/mainloop.hpp" 43 #include "rest/parser.hpp" 44 #include "rest/resource.hpp" 45 46 using std::chrono::steady_clock; 47 48 namespace otbr { 49 namespace rest { 50 51 /** 52 * This class implements a Connection class of each socket connection. 53 * 54 */ 55 class Connection : public MainloopProcessor 56 { 57 public: 58 /** 59 * The constructor is to initialize a socket connection instance. 60 * 61 * @param[in] aStartTime The reference start time of a connection which 62 * is set when created for the first time and maybe 63 * reset when transfer to wait callback or wait write 64 * state. 65 * @param[in] aResource A pointer to the resource handler. 66 * @param[in] aFd The file descriptor for the connection. 67 * 68 */ 69 Connection(steady_clock::time_point aStartTime, Resource *aResource, int aFd); 70 71 /** 72 * The desctructor destroys the connection instance. 73 * 74 */ 75 ~Connection(void) override; 76 77 /** 78 * This method initializes the connection. 79 * 80 * 81 */ 82 void Init(void); 83 84 void Update(MainloopContext &aMainloop) override; 85 void Process(const MainloopContext &aMainloop) override; 86 87 /** 88 * This method indicates whether this connection no longer need to be processed. 89 * 90 * @retval TRUE This connection could be released in next loop. 91 * @retval FALSE This connection still needs to be processed in next loop. 92 * 93 */ 94 bool IsComplete(void) const; 95 96 private: 97 void UpdateReadFdSet(fd_set &aReadFdSet, int &aMaxFd) const; 98 void UpdateWriteFdSet(fd_set &aWriteFdSet, int &aMaxFd) const; 99 void UpdateTimeout(timeval &aTimeout) const; 100 void ProcessWaitRead(const fd_set &aReadFdSet); 101 void ProcessWaitCallback(void); 102 void ProcessWaitWrite(const fd_set &aWriteFdSet); 103 void Write(void); 104 void Handle(void); 105 void Disconnect(void); 106 107 // Timestamp used for each check point of a connection 108 steady_clock::time_point mTimeStamp; 109 110 // File descriptor for this connection 111 int mFd; 112 113 // Enum indicates the state of this connection 114 ConnectionState mState; 115 116 // Response instance binded to this connection 117 Response mResponse; 118 119 // Request instance binded to this connection 120 Request mRequest; 121 122 // HTTP parser instance 123 Parser mParser; 124 125 // Resource handler instance 126 Resource *mResource; 127 128 // Write buffer in case write multiple times 129 std::string mWriteContent; 130 }; 131 132 } // namespace rest 133 } // namespace otbr 134 135 #endif // OTBR_REST_CONNECTION_HPP_ 136