third_party/ot-br-posix/repo/src/rest/rest_web_server.hpp

   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 definitions for RESTful HTTP server.
  32  */
  33
  34 #ifndef OTBR_REST_REST_WEB_SERVER_HPP_
  35 #define OTBR_REST_REST_WEB_SERVER_HPP_
  36
  37 #include "rest/connection.hpp"
  38
  39 using otbr::Ncp::ControllerOpenThread;
  40 using std::chrono::steady_clock;
  41
  42 namespace otbr {
  43 namespace rest {
  44
  45 /**
  46  * This class implements a REST server.
  47  *
  48  */
  49 class RestWebServer
  50 {
  51 public:
  52     /**
  53      * a static function which call the constructor of REST server and return a pointer to the server instance.
  54      *
  55      * @param[in]   aNcp  A pointer to the NCP controller.
  56      *
  57      * @returns A pointer pointing to the static rest server instance.
  58      *
  59      */
  60     static RestWebServer *GetRestWebServer(ControllerOpenThread *aNcp);
  61
  62     /**
  63      * This method initializes the REST server.
  64      *
  65      */
  66     void Init(void);
  67
  68     /**
  69      * This method updates the file descriptor sets and timeout for mainloop.
  70      *
  71      * @param[inout]    aMainloop   A reference to OpenThread mainloop context.
  72      *
  73      */
  74     void UpdateFdSet(otSysMainloopContext &aMainloop);
  75
  76     /**
  77      * This method performs processing.
  78      *
  79      * @param[in]       aMainloop   A reference to OpenThread mainloop context.
  80      *
  81      */
  82     otbrError Process(otSysMainloopContext &aMainloop);
  83
  84 private:
  85     RestWebServer(ControllerOpenThread *aNcp);
  86     otbrError UpdateConnections(fd_set &aReadFdSet);
  87     void      CreateNewConnection(int32_t &aFd);
  88     otbrError Accept(int32_t aListenFd);
  89     void      InitializeListenFd(void);
  90     bool      SetFdNonblocking(int32_t fd);
  91
  92     // Resource handler
  93     Resource mResource;
  94     // Struct for server configuration
  95     sockaddr_in mAddress;
  96     // File descriptor for listening
  97     int32_t mListenFd;
  98     // Connection List
  99     std::unordered_map<int32_t, std::unique_ptr<Connection>> mConnectionSet;
 100 };
 101
 102 } // namespace rest
 103 } // namespace otbr
 104
 105 #endif // OTBR_REST_REST_WEB_SERVER_HPP_