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