1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153 | // Copyright (C) 2019-2024 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
#ifndef HTTP_LISTENER_IMPL_H
#define HTTP_LISTENER_IMPL_H
#include <asiolink/io_service.h>
#include <asiolink/io_address.h>
#include <asiolink/tcp_endpoint.h>
#include <http/connection.h>
#include <http/connection_pool.h>
#include <http/response_creator_factory.h>
#include <boost/enable_shared_from_this.hpp><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <boost/scoped_ptr.hpp><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
namespace isc {
namespace http {
/// @brief Implementation of the @ref HttpListener.
class HttpListenerImpl : public boost::enable_shared_from_this<HttpListenerImpl> {
public:
/// @brief Constructor.
///
/// This constructor creates new server endpoint using the specified IP
/// address and port. It also validates other specified parameters.
///
/// This constructor does not start accepting new connections! To start
/// accepting connections run @ref HttpListener::start.
///
/// @param io_service IO service to be used by the listener.
/// @param server_address Address on which the HTTP service should run.
/// @param server_port Port number on which the HTTP service should run.
/// @param tls_context TLS context.
/// @param creator_factory Pointer to the caller-defined
/// @ref HttpResponseCreatorFactory derivation which should be used to
/// create @ref HttpResponseCreator instances.
/// @param request_timeout Timeout after which the HTTP Request Timeout
/// is generated.
/// @param idle_timeout Timeout after which an idle persistent HTTP
/// connection is closed by the server.
///
/// @throw HttpListenerError when any of the specified parameters is
/// invalid.
HttpListenerImpl(const asiolink::IOServicePtr& io_service,
const asiolink::IOAddress& server_address,
const unsigned short server_port,
const asiolink::TlsContextPtr& tls_context,
const HttpResponseCreatorFactoryPtr& creator_factory,
const long request_timeout,
const long idle_timeout);
/// @brief Virtual destructor.
virtual ~HttpListenerImpl() {
}
/// @brief Returns reference to the current listener endpoint.
const asiolink::TCPEndpoint& getEndpoint() const;
/// @brief Returns reference to the current TLS context.
const asiolink::TlsContextPtr& getTlsContext() const;
/// @brief file descriptor of the underlying acceptor socket.
int getNative() const;
/// @brief Use external sockets flag.
///
/// Add sockets as external sockets of the interface manager
/// so available I/O on them makes a waiting select to return.
///
/// @param use_external True add external sockets.
void addExternalSockets(bool use_external);
/// @brief Starts accepting new connections.
///
/// This method starts accepting and handling new HTTP connections on
/// the IP address and port number specified in the constructor.
///
/// If the method is invoked successfully, it must not be invoked again
/// until @ref HttpListener::stop is called.
///
/// @throw HttpListenerError if an error occurred.
void start();
/// @brief Stops all active connections and shuts down the service.
void stop();
protected:
/// @brief Creates @ref HttpConnection instance and adds it to the
/// pool of active connections.
///
/// The next accepted connection will be handled by this instance.
void accept();
/// @brief Callback invoked when the new connection is accepted.
///
/// It calls @c HttpListener::accept to create new @c HttpConnection
/// instance.
///
/// @param ec Error code passed to the handler. This is currently ignored.
void acceptHandler(const boost::system::error_code& ec);
/// @brief Creates an instance of the @c HttpConnection.
///
/// This method is virtual so as it can be overridden when customized
/// connections are to be used, e.g. in case of unit testing.
///
/// @param response_creator Pointer to the response creator object used to
/// create HTTP response from the HTTP request received.
/// @param callback Callback invoked when new connection is accepted.
///
/// @return Pointer to the created connection.
virtual HttpConnectionPtr createConnection(const HttpResponseCreatorPtr& response_creator,
const HttpAcceptorCallback& callback);
/// @brief Pointer to the IO service.
asiolink::IOServicePtr io_service_;
/// @brief TLS context.
asiolink::TlsContextPtr tls_context_;
/// @brief Acceptor instance.
HttpAcceptorPtr acceptor_;
/// @brief Pointer to the endpoint representing IP address and port on
/// which the service is running.
boost::scoped_ptr<asiolink::TCPEndpoint> endpoint_;
/// @brief Pool of active connections.
HttpConnectionPoolPtr connections_;
/// @brief Pointer to the @ref HttpResponseCreatorFactory.
HttpResponseCreatorFactoryPtr creator_factory_;
/// @brief Timeout for HTTP Request Timeout desired.
long request_timeout_;
/// @brief Timeout after which idle persistent connection is closed by
/// the server.
long idle_timeout_;
/// @brief Use external sockets flag.
bool use_external_;
};
} // end of namespace isc::http
} // end of namespace isc
#endif // HTTP_LISTENER_IMPL_H
|