forked from pocoproject/poco
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathTCPServer.h
More file actions
executable file
·206 lines (169 loc) · 6.59 KB
/
TCPServer.h
File metadata and controls
executable file
·206 lines (169 loc) · 6.59 KB
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
//
// TCPServer.h
//
// $Id: //poco/1.4/Net/include/Poco/Net/TCPServer.h#1 $
//
// Library: Net
// Package: TCPServer
// Module: TCPServer
//
// Definition of the TCPServer class.
//
// Copyright (c) 2005-2006, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// SPDX-License-Identifier: BSL-1.0
//
#ifndef Net_TCPServer_INCLUDED
#define Net_TCPServer_INCLUDED
#include "Poco/Net/Net.h"
#include "Poco/Net/ServerSocket.h"
#include "Poco/Net/TCPServerConnectionFactory.h"
#include "Poco/Net/TCPServerParams.h"
#include "Poco/Runnable.h"
#include "Poco/Thread.h"
#include "Poco/ThreadPool.h"
namespace Poco {
namespace Net {
class TCPServerDispatcher;
class Net_API TCPServer: public Poco::Runnable
/// This class implements a multithreaded TCP server.
///
/// The server uses a ServerSocket to listen for incoming
/// connections. The ServerSocket must have been bound to
/// an address before it is passed to the TCPServer constructor.
/// Additionally, the ServerSocket must be put into listening
/// state before the TCPServer is started by calling the start()
/// method.
///
/// The server uses a thread pool to assign threads to incoming
/// connections. Before incoming connections are assigned to
/// a connection thread, they are put into a queue.
/// Connection threads fetch new connections from the queue as soon
/// as they become free. Thus, a connection thread may serve more
/// than one connection.
///
/// As soon as a connection thread fetches the next connection from
/// the queue, it creates a TCPServerConnection object for it
/// (using the TCPServerConnectionFactory passed to the constructor)
/// and calls the TCPServerConnection's start() method. When the
/// start() method returns, the connection object is deleted.
///
/// The number of connection threads is adjusted dynamically, depending
/// on the number of connections waiting to be served.
///
/// It is possible to specify a maximum number of queued connections.
/// This prevents the connection queue from overflowing in the
/// case of an extreme server load. In such a case, connections that
/// cannot be queued are silently and immediately closed.
///
/// TCPServer uses a separate thread to accept incoming connections.
/// Thus, the call to start() returns immediately, and the server
/// continues to run in the background.
///
/// To stop the server from accepting new connections, call stop().
///
/// After calling stop(), no new connections will be accepted and
/// all queued connections will be discarded.
/// Already served connections, however, will continue being served.
{
public:
TCPServer(TCPServerConnectionFactory::Ptr pFactory, Poco::UInt16 portNumber = 0, TCPServerParams::Ptr pParams = 0);
/// Creates the TCPServer, with ServerSocket listening on the given port.
/// Default port is zero, allowing any availble port. The port number
/// can be queried through TCPServer::port() member.
///
/// The server takes ownership of the TCPServerConnectionFactory
/// and deletes it when it's no longer needed.
///
/// The server also takes ownership of the TCPServerParams object.
/// If no TCPServerParams object is given, the server's TCPServerDispatcher
/// creates its own one.
///
/// New threads are taken from the default thread pool.
TCPServer(TCPServerConnectionFactory::Ptr pFactory, const ServerSocket& socket, TCPServerParams::Ptr pParams = 0);
/// Creates the TCPServer, using the given ServerSocket.
///
/// The server takes ownership of the TCPServerConnectionFactory
/// and deletes it when it's no longer needed.
///
/// The server also takes ownership of the TCPServerParams object.
/// If no TCPServerParams object is given, the server's TCPServerDispatcher
/// creates its own one.
///
/// New threads are taken from the default thread pool.
TCPServer(TCPServerConnectionFactory::Ptr pFactory, Poco::ThreadPool& threadPool, const ServerSocket& socket, TCPServerParams::Ptr pParams = 0);
/// Creates the TCPServer, using the given ServerSocket.
///
/// The server takes ownership of the TCPServerConnectionFactory
/// and deletes it when it's no longer needed.
///
/// The server also takes ownership of the TCPServerParams object.
/// If no TCPServerParams object is given, the server's TCPServerDispatcher
/// creates its own one.
///
/// New threads are taken from the given thread pool.
virtual ~TCPServer();
/// Destroys the TCPServer and its TCPServerConnectionFactory.
const TCPServerParams& params() const;
/// Returns a const reference to the TCPServerParam object
/// used by the server's TCPServerDispatcher.
void start();
/// Starts the server. A new thread will be
/// created that waits for and accepts incoming
/// connections.
///
/// Before start() is called, the ServerSocket passed to
/// TCPServer must have been bound and put into listening state.
void stop();
/// Stops the server.
///
/// No new connections will be accepted.
/// Already handled connections will continue to be served.
///
/// Once the server has been stopped, it cannot be restarted.
int currentThreads() const;
/// Returns the number of currently used connection threads.
int maxThreads() const;
/// Returns the maximum number of threads available.
int totalConnections() const;
/// Returns the total number of handled connections.
int currentConnections() const;
/// Returns the number of currently handled connections.
int maxConcurrentConnections() const;
/// Returns the maximum number of concurrently handled connections.
int queuedConnections() const;
/// Returns the number of queued connections.
int refusedConnections() const;
/// Returns the number of refused connections.
const ServerSocket& socket() const;
/// Returns the underlying server socket.
Poco::UInt16 port() const;
/// Returns the port the server socket listens on.
protected:
void run();
/// Runs the server. The server will run until
/// the stop() method is called, or the server
/// object is destroyed, which implicitly calls
/// the stop() method.
static std::string threadName(const ServerSocket& socket);
/// Returns a thread name for the server thread.
private:
TCPServer();
TCPServer(const TCPServer&);
TCPServer& operator = (const TCPServer&);
ServerSocket _socket;
TCPServerDispatcher* _pDispatcher;
Poco::Thread _thread;
bool _stopped;
};
inline const ServerSocket& TCPServer::socket() const
{
return _socket;
}
inline Poco::UInt16 TCPServer::port() const
{
return _socket.address().port();
}
} } // namespace Poco::Net
#endif // Net_TCPServer_INCLUDED