• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 "openthread-br/config.h"
38 
39 #include <netinet/in.h>
40 #include <netinet/ip.h>
41 #include <sys/socket.h>
42 
43 #include "common/mainloop.hpp"
44 #include "rest/connection.hpp"
45 
46 using otbr::Ncp::ControllerOpenThread;
47 using std::chrono::steady_clock;
48 
49 namespace otbr {
50 namespace rest {
51 
52 /**
53  * This class implements a REST server.
54  *
55  */
56 class RestWebServer : public MainloopProcessor
57 {
58 public:
59     /**
60      * The constructor to initialize a REST server.
61      *
62      * @param[in] aNcp  A reference to the NCP controller.
63      *
64      */
65     RestWebServer(ControllerOpenThread &aNcp, const std::string &aRestListenAddress, int aRestListenPort);
66 
67     /**
68      * The destructor destroys the server instance.
69      *
70      */
71     ~RestWebServer(void) override;
72 
73     /**
74      * This method initializes the REST server.
75      *
76      */
77     void Init(void);
78 
79     void Update(MainloopContext &aMainloop) override;
80     void Process(const MainloopContext &aMainloop) override;
81 
82 private:
83     void      UpdateConnections(const fd_set &aReadFdSet);
84     void      CreateNewConnection(int32_t &aFd);
85     otbrError Accept(int32_t aListenFd);
86     bool      ParseListenAddress(const std::string listenAddress, struct in6_addr *sin6_addr);
87     void      InitializeListenFd(void);
88     bool      SetFdNonblocking(int32_t fd);
89 
90     // Resource handler
91     Resource mResource;
92     // Struct for server configuration
93     sockaddr_in6 mAddress;
94     // File descriptor for listening
95     int32_t mListenFd;
96     // Connection List
97     std::unordered_map<int32_t, std::unique_ptr<Connection>> mConnectionSet;
98 };
99 
100 } // namespace rest
101 } // namespace otbr
102 
103 #endif // OTBR_REST_REST_WEB_SERVER_HPP_
104