/usr/include/pion/tcp/server.hpp is in libpion-dev 5.0.4+dfsg-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 | // ---------------------------------------------------------------------
// pion: a Boost C++ framework for building lightweight HTTP interfaces
// ---------------------------------------------------------------------
// Copyright (C) 2007-2012 Cloudmeter, Inc. (http://www.cloudmeter.com)
//
// Distributed under the Boost Software License, Version 1.0.
// See http://www.boost.org/LICENSE_1_0.txt
//
#ifndef __PION_TCP_SERVER_HEADER__
#define __PION_TCP_SERVER_HEADER__
#include <set>
#include <boost/asio.hpp>
#include <boost/noncopyable.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/thread/mutex.hpp>
#include <boost/thread/condition.hpp>
#include <pion/config.hpp>
#include <pion/logger.hpp>
#include <pion/scheduler.hpp>
#include <pion/tcp/connection.hpp>
namespace pion { // begin namespace pion
namespace tcp { // begin namespace tcp
///
/// tcp::server: a multi-threaded, asynchronous TCP server
///
class PION_API server :
private boost::noncopyable
{
public:
/// default destructor
virtual ~server() { if (m_is_listening) stop(false); }
/// starts listening for new connections
void start(void);
/**
* stops listening for new connections
*
* @param wait_until_finished if true, blocks until all pending connections have closed
*/
void stop(bool wait_until_finished = false);
/// the calling thread will sleep until the server has stopped listening for connections
void join(void);
/**
* configures server for SSL using a PEM-encoded RSA private key file
*
* @param pem_key_file name of the file containing a PEM-encoded private key
*/
void set_ssl_key_file(const std::string& pem_key_file);
/// returns the number of active tcp connections
std::size_t get_connections(void) const;
/// returns tcp port number that the server listens for connections on
inline unsigned int get_port(void) const { return m_endpoint.port(); }
/// sets tcp port number that the server listens for connections on
inline void set_port(unsigned int p) { m_endpoint.port(p); }
/// returns IP address that the server listens for connections on
inline boost::asio::ip::address get_address(void) const { return m_endpoint.address(); }
/// sets IP address that the server listens for connections on
inline void set_address(const boost::asio::ip::address& addr) { m_endpoint.address(addr); }
/// returns tcp endpoint that the server listens for connections on
inline const boost::asio::ip::tcp::endpoint& get_endpoint(void) const { return m_endpoint; }
/// sets tcp endpoint that the server listens for connections on
inline void set_endpoint(const boost::asio::ip::tcp::endpoint& ep) { m_endpoint = ep; }
/// returns true if the server uses SSL to encrypt connections
inline bool get_ssl_flag(void) const { return m_ssl_flag; }
/// sets value of SSL flag (true if the server uses SSL to encrypt connections)
inline void set_ssl_flag(bool b = true) { m_ssl_flag = b; }
/// returns the SSL context for configuration
inline connection::ssl_context_type& get_ssl_context_type(void) { return m_ssl_context; }
/// returns true if the server is listening for connections
inline bool is_listening(void) const { return m_is_listening; }
/// sets the logger to be used
inline void set_logger(logger log_ptr) { m_logger = log_ptr; }
/// returns the logger currently in use
inline logger get_logger(void) { return m_logger; }
/// returns mutable reference to the TCP connection acceptor
inline boost::asio::ip::tcp::acceptor& get_acceptor(void) { return m_tcp_acceptor; }
/// returns const reference to the TCP connection acceptor
inline const boost::asio::ip::tcp::acceptor& get_acceptor(void) const { return m_tcp_acceptor; }
protected:
/**
* protected constructor so that only derived objects may be created
*
* @param tcp_port port number used to listen for new connections (IPv4)
*/
explicit server(const unsigned int tcp_port);
/**
* protected constructor so that only derived objects may be created
*
* @param endpoint TCP endpoint used to listen for new connections (see ASIO docs)
*/
explicit server(const boost::asio::ip::tcp::endpoint& endpoint);
/**
* protected constructor so that only derived objects may be created
*
* @param sched the scheduler that will be used to manage worker threads
* @param tcp_port port number used to listen for new connections (IPv4)
*/
explicit server(scheduler& sched, const unsigned int tcp_port = 0);
/**
* protected constructor so that only derived objects may be created
*
* @param sched the scheduler that will be used to manage worker threads
* @param endpoint TCP endpoint used to listen for new connections (see ASIO docs)
*/
server(scheduler& sched, const boost::asio::ip::tcp::endpoint& endpoint);
/**
* handles a new TCP connection; derived classes SHOULD override this
* since the default behavior does nothing
*
* @param tcp_conn the new TCP connection to handle
*/
virtual void handle_connection(tcp::connection_ptr& tcp_conn) {
tcp_conn->set_lifecycle(connection::LIFECYCLE_CLOSE); // make sure it will get closed
tcp_conn->finish();
}
/// called before the TCP server starts listening for new connections
virtual void before_starting(void) {}
/// called after the TCP server has stopped listing for new connections
virtual void after_stopping(void) {}
/// returns an async I/O service used to schedule work
inline boost::asio::io_service& get_io_service(void) { return m_active_scheduler.get_io_service(); }
/// primary logging interface used by this class
logger m_logger;
private:
/// handles a request to stop the server
void handle_stop_request(void);
/// listens for a new connection
void listen(void);
/**
* handles new connections (checks if there was an accept error)
*
* @param tcp_conn the new TCP connection (if no error occurred)
* @param accept_error true if an error occurred while accepting connections
*/
void handle_accept(tcp::connection_ptr& tcp_conn,
const boost::system::error_code& accept_error);
/**
* handles new connections following an SSL handshake (checks for errors)
*
* @param tcp_conn the new TCP connection (if no error occurred)
* @param handshake_error true if an error occurred during the SSL handshake
*/
void handle_ssl_handshake(tcp::connection_ptr& tcp_conn,
const boost::system::error_code& handshake_error);
/// This will be called by connection::finish() after a server has
/// finished handling a connection. If the keep_alive flag is true,
/// it will call handle_connection(); otherwise, it will close the
/// connection and remove it from the server's management pool
void finish_connection(tcp::connection_ptr& tcp_conn);
/// prunes orphaned connections that did not close cleanly
/// and returns the remaining number of connections in the pool
std::size_t prune_connections(void);
/// data type for a pool of TCP connections
typedef std::set<tcp::connection_ptr> ConnectionPool;
/// the default scheduler object used to manage worker threads
single_service_scheduler m_default_scheduler;
/// reference to the active scheduler object used to manage worker threads
scheduler & m_active_scheduler;
/// manages async TCP connections
boost::asio::ip::tcp::acceptor m_tcp_acceptor;
/// context used for SSL configuration
connection::ssl_context_type m_ssl_context;
/// condition triggered when the server has stopped listening for connections
boost::condition m_server_has_stopped;
/// condition triggered when the connection pool is empty
boost::condition m_no_more_connections;
/// pool of active connections associated with this server
ConnectionPool m_conn_pool;
/// tcp endpoint used to listen for new connections
boost::asio::ip::tcp::endpoint m_endpoint;
/// true if the server uses SSL to encrypt connections
bool m_ssl_flag;
/// set to true when the server is listening for new connections
bool m_is_listening;
/// mutex to make class thread-safe
mutable boost::mutex m_mutex;
};
/// data type for a server pointer
typedef boost::shared_ptr<server> server_ptr;
} // end namespace tcp
} // end namespace pion
#endif
|