/usr/share/doc/libpion-doc/html/tcp_2server_8hpp_source.html is in libpion-doc 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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>pion: include/pion/tcp/server.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<h1>include/pion/tcp/server.hpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// ---------------------------------------------------------------------</span>
<a name="l00002"></a>00002 <span class="comment">// pion: a Boost C++ framework for building lightweight HTTP interfaces</span>
<a name="l00003"></a>00003 <span class="comment">// ---------------------------------------------------------------------</span>
<a name="l00004"></a>00004 <span class="comment">// Copyright (C) 2007-2012 Cloudmeter, Inc. (http://www.cloudmeter.com)</span>
<a name="l00005"></a>00005 <span class="comment">//</span>
<a name="l00006"></a>00006 <span class="comment">// Distributed under the Boost Software License, Version 1.0.</span>
<a name="l00007"></a>00007 <span class="comment">// See http://www.boost.org/LICENSE_1_0.txt</span>
<a name="l00008"></a>00008 <span class="comment">//</span>
<a name="l00009"></a>00009
<a name="l00010"></a>00010 <span class="preprocessor">#ifndef __PION_TCP_SERVER_HEADER__</span>
<a name="l00011"></a>00011 <span class="preprocessor"></span><span class="preprocessor">#define __PION_TCP_SERVER_HEADER__</span>
<a name="l00012"></a>00012 <span class="preprocessor"></span>
<a name="l00013"></a>00013 <span class="preprocessor">#include <set></span>
<a name="l00014"></a>00014 <span class="preprocessor">#include <boost/asio.hpp></span>
<a name="l00015"></a>00015 <span class="preprocessor">#include <boost/noncopyable.hpp></span>
<a name="l00016"></a>00016 <span class="preprocessor">#include <boost/shared_ptr.hpp></span>
<a name="l00017"></a>00017 <span class="preprocessor">#include <boost/thread/mutex.hpp></span>
<a name="l00018"></a>00018 <span class="preprocessor">#include <boost/thread/condition.hpp></span>
<a name="l00019"></a>00019 <span class="preprocessor">#include <pion/config.hpp></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include <pion/logger.hpp></span>
<a name="l00021"></a>00021 <span class="preprocessor">#include <pion/scheduler.hpp></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include <pion/tcp/connection.hpp></span>
<a name="l00023"></a>00023
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="keyword">namespace </span>pion { <span class="comment">// begin namespace pion</span>
<a name="l00026"></a>00026 <span class="keyword">namespace </span>tcp { <span class="comment">// begin namespace tcp</span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028
<a name="l00032"></a><a class="code" href="classpion_1_1tcp_1_1server.html">00032</a> <span class="keyword">class </span>PION_API <a class="code" href="classpion_1_1tcp_1_1server.html">server</a> :
<a name="l00033"></a>00033 <span class="keyword">private</span> boost::noncopyable
<a name="l00034"></a>00034 {
<a name="l00035"></a>00035 <span class="keyword">public</span>:
<a name="l00036"></a>00036
<a name="l00038"></a><a class="code" href="classpion_1_1tcp_1_1server.html#a728020c37ae9ec06197d01b195a24f9e">00038</a> <span class="keyword">virtual</span> <a class="code" href="classpion_1_1tcp_1_1server.html#a728020c37ae9ec06197d01b195a24f9e" title="default destructor">~server</a>() { <span class="keywordflow">if</span> (m_is_listening) stop(<span class="keyword">false</span>); }
<a name="l00039"></a>00039
<a name="l00041"></a>00041 <span class="keywordtype">void</span> start(<span class="keywordtype">void</span>);
<a name="l00042"></a>00042
<a name="l00048"></a>00048 <span class="keywordtype">void</span> stop(<span class="keywordtype">bool</span> wait_until_finished = <span class="keyword">false</span>);
<a name="l00049"></a>00049
<a name="l00051"></a>00051 <span class="keywordtype">void</span> join(<span class="keywordtype">void</span>);
<a name="l00052"></a>00052
<a name="l00058"></a>00058 <span class="keywordtype">void</span> set_ssl_key_file(<span class="keyword">const</span> std::string& pem_key_file);
<a name="l00059"></a>00059
<a name="l00061"></a>00061 std::size_t get_connections(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
<a name="l00062"></a>00062
<a name="l00064"></a><a class="code" href="classpion_1_1tcp_1_1server.html#a46c1027475b8748e2a3047c7b738ef0b">00064</a> <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classpion_1_1tcp_1_1server.html#a46c1027475b8748e2a3047c7b738ef0b" title="returns tcp port number that the server listens for connections on">get_port</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_endpoint.port(); }
<a name="l00065"></a>00065
<a name="l00067"></a><a class="code" href="classpion_1_1tcp_1_1server.html#a392e9ede66cf2f96af52655363951e96">00067</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classpion_1_1tcp_1_1server.html#a392e9ede66cf2f96af52655363951e96" title="sets tcp port number that the server listens for connections on">set_port</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> p) { m_endpoint.port(p); }
<a name="l00068"></a>00068
<a name="l00070"></a><a class="code" href="classpion_1_1tcp_1_1server.html#a4ed7743219642eb5969e3599403ad99f">00070</a> <span class="keyword">inline</span> boost::asio::ip::address <a class="code" href="classpion_1_1tcp_1_1server.html#a4ed7743219642eb5969e3599403ad99f" title="returns IP address that the server listens for connections on">get_address</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_endpoint.address(); }
<a name="l00071"></a>00071
<a name="l00073"></a><a class="code" href="classpion_1_1tcp_1_1server.html#aa711c8de12d16c2806dc5fe57bed512e">00073</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classpion_1_1tcp_1_1server.html#aa711c8de12d16c2806dc5fe57bed512e" title="sets IP address that the server listens for connections on">set_address</a>(<span class="keyword">const</span> boost::asio::ip::address& addr) { m_endpoint.address(addr); }
<a name="l00074"></a>00074
<a name="l00076"></a><a class="code" href="classpion_1_1tcp_1_1server.html#adb38f532cf2c4f798c10a9273e7af436">00076</a> <span class="keyword">inline</span> <span class="keyword">const</span> boost::asio::ip::tcp::endpoint& <a class="code" href="classpion_1_1tcp_1_1server.html#adb38f532cf2c4f798c10a9273e7af436" title="returns tcp endpoint that the server listens for connections on">get_endpoint</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_endpoint; }
<a name="l00077"></a>00077
<a name="l00079"></a><a class="code" href="classpion_1_1tcp_1_1server.html#a2f460aa6795aa6169c1b1fca5c4daa21">00079</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classpion_1_1tcp_1_1server.html#a2f460aa6795aa6169c1b1fca5c4daa21" title="sets tcp endpoint that the server listens for connections on">set_endpoint</a>(<span class="keyword">const</span> boost::asio::ip::tcp::endpoint& ep) { m_endpoint = ep; }
<a name="l00080"></a>00080
<a name="l00082"></a><a class="code" href="classpion_1_1tcp_1_1server.html#a90c7fd50d43652de3f283988380968bb">00082</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classpion_1_1tcp_1_1server.html#a90c7fd50d43652de3f283988380968bb" title="returns true if the server uses SSL to encrypt connections">get_ssl_flag</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_ssl_flag; }
<a name="l00083"></a>00083
<a name="l00085"></a><a class="code" href="classpion_1_1tcp_1_1server.html#ac6bb13e1f833a39b28bff7fa71029476">00085</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classpion_1_1tcp_1_1server.html#ac6bb13e1f833a39b28bff7fa71029476" title="sets value of SSL flag (true if the server uses SSL to encrypt connections)">set_ssl_flag</a>(<span class="keywordtype">bool</span> b = <span class="keyword">true</span>) { m_ssl_flag = b; }
<a name="l00086"></a>00086
<a name="l00088"></a><a class="code" href="classpion_1_1tcp_1_1server.html#a11201c6b34424ff5ec11c963629281ed">00088</a> <span class="keyword">inline</span> <a class="code" href="classpion_1_1tcp_1_1connection.html#ae3e4aa69cacf69d2b9907dbda79b1f54" title="data type for SSL configuration context">connection::ssl_context_type</a>& <a class="code" href="classpion_1_1tcp_1_1server.html#a11201c6b34424ff5ec11c963629281ed" title="returns the SSL context for configuration">get_ssl_context_type</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> m_ssl_context; }
<a name="l00089"></a>00089
<a name="l00091"></a><a class="code" href="classpion_1_1tcp_1_1server.html#acf9efd8fcf78fc352744489e388b0f7c">00091</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classpion_1_1tcp_1_1server.html#acf9efd8fcf78fc352744489e388b0f7c" title="returns true if the server is listening for connections">is_listening</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_is_listening; }
<a name="l00092"></a>00092
<a name="l00094"></a><a class="code" href="classpion_1_1tcp_1_1server.html#abe68393818a75e45d49757532802361e">00094</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classpion_1_1tcp_1_1server.html#abe68393818a75e45d49757532802361e" title="sets the logger to be used">set_logger</a>(logger log_ptr) { m_logger = log_ptr; }
<a name="l00095"></a>00095
<a name="l00097"></a><a class="code" href="classpion_1_1tcp_1_1server.html#af038c70801875d3d6a3826eb7a80b1c3">00097</a> <span class="keyword">inline</span> logger <a class="code" href="classpion_1_1tcp_1_1server.html#af038c70801875d3d6a3826eb7a80b1c3" title="returns the logger currently in use">get_logger</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> m_logger; }
<a name="l00098"></a>00098
<a name="l00100"></a><a class="code" href="classpion_1_1tcp_1_1server.html#a41d5b598e52f70db5ae4302bb02370b8">00100</a> <span class="keyword">inline</span> boost::asio::ip::tcp::acceptor& <a class="code" href="classpion_1_1tcp_1_1server.html#a41d5b598e52f70db5ae4302bb02370b8" title="returns mutable reference to the TCP connection acceptor">get_acceptor</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> m_tcp_acceptor; }
<a name="l00101"></a>00101
<a name="l00103"></a><a class="code" href="classpion_1_1tcp_1_1server.html#a98de565795e8a1e978d21e7232990efe">00103</a> <span class="keyword">inline</span> <span class="keyword">const</span> boost::asio::ip::tcp::acceptor& <a class="code" href="classpion_1_1tcp_1_1server.html#a98de565795e8a1e978d21e7232990efe" title="returns const reference to the TCP connection acceptor">get_acceptor</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_tcp_acceptor; }
<a name="l00104"></a>00104
<a name="l00105"></a>00105
<a name="l00106"></a>00106 <span class="keyword">protected</span>:
<a name="l00107"></a>00107
<a name="l00113"></a>00113 <span class="keyword">explicit</span> <a class="code" href="classpion_1_1tcp_1_1server.html">server</a>(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> tcp_port);
<a name="l00114"></a>00114
<a name="l00120"></a>00120 <span class="keyword">explicit</span> <a class="code" href="classpion_1_1tcp_1_1server.html">server</a>(<span class="keyword">const</span> boost::asio::ip::tcp::endpoint& endpoint);
<a name="l00121"></a>00121
<a name="l00128"></a>00128 <span class="keyword">explicit</span> <a class="code" href="classpion_1_1tcp_1_1server.html">server</a>(<a class="code" href="classpion_1_1scheduler.html">scheduler</a>& sched, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> tcp_port = 0);
<a name="l00129"></a>00129
<a name="l00136"></a>00136 <a class="code" href="classpion_1_1tcp_1_1server.html">server</a>(<a class="code" href="classpion_1_1scheduler.html">scheduler</a>& sched, <span class="keyword">const</span> boost::asio::ip::tcp::endpoint& endpoint);
<a name="l00137"></a>00137
<a name="l00144"></a><a class="code" href="classpion_1_1tcp_1_1server.html#a4ec9c99b1125d0190ceb7850edb77f66">00144</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classpion_1_1tcp_1_1server.html#a4ec9c99b1125d0190ceb7850edb77f66">handle_connection</a>(tcp::connection_ptr& tcp_conn) {
<a name="l00145"></a>00145 tcp_conn->set_lifecycle(connection::LIFECYCLE_CLOSE); <span class="comment">// make sure it will get closed</span>
<a name="l00146"></a>00146 tcp_conn->finish();
<a name="l00147"></a>00147 }
<a name="l00148"></a>00148
<a name="l00150"></a><a class="code" href="classpion_1_1tcp_1_1server.html#a814a44fc3d677071b9e2407898765316">00150</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classpion_1_1tcp_1_1server.html#a814a44fc3d677071b9e2407898765316" title="called before the TCP server starts listening for new connections">before_starting</a>(<span class="keywordtype">void</span>) {}
<a name="l00151"></a>00151
<a name="l00153"></a><a class="code" href="classpion_1_1tcp_1_1server.html#a23766baf23b7b5be2e43da55547c3a31">00153</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classpion_1_1tcp_1_1server.html#a23766baf23b7b5be2e43da55547c3a31" title="called after the TCP server has stopped listing for new connections">after_stopping</a>(<span class="keywordtype">void</span>) {}
<a name="l00154"></a>00154
<a name="l00156"></a><a class="code" href="classpion_1_1tcp_1_1server.html#a436e6dbcc3b128b2f9a9be6fd99421b6">00156</a> <span class="keyword">inline</span> boost::asio::io_service& <a class="code" href="classpion_1_1tcp_1_1server.html#a436e6dbcc3b128b2f9a9be6fd99421b6" title="returns an async I/O service used to schedule work">get_io_service</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> m_active_scheduler.get_io_service(); }
<a name="l00157"></a>00157
<a name="l00158"></a>00158
<a name="l00160"></a><a class="code" href="classpion_1_1tcp_1_1server.html#a0fd391b946961fca8604b902ddb06f7d">00160</a> logger m_logger;
<a name="l00161"></a>00161
<a name="l00162"></a>00162
<a name="l00163"></a>00163 <span class="keyword">private</span>:
<a name="l00164"></a>00164
<a name="l00166"></a>00166 <span class="keywordtype">void</span> handle_stop_request(<span class="keywordtype">void</span>);
<a name="l00167"></a>00167
<a name="l00169"></a>00169 <span class="keywordtype">void</span> listen(<span class="keywordtype">void</span>);
<a name="l00170"></a>00170
<a name="l00177"></a>00177 <span class="keywordtype">void</span> handle_accept(tcp::connection_ptr& tcp_conn,
<a name="l00178"></a>00178 <span class="keyword">const</span> boost::system::error_code& accept_error);
<a name="l00179"></a>00179
<a name="l00186"></a>00186 <span class="keywordtype">void</span> handle_ssl_handshake(tcp::connection_ptr& tcp_conn,
<a name="l00187"></a>00187 <span class="keyword">const</span> boost::system::error_code& handshake_error);
<a name="l00188"></a>00188
<a name="l00193"></a>00193 <span class="keywordtype">void</span> finish_connection(tcp::connection_ptr& tcp_conn);
<a name="l00194"></a>00194
<a name="l00197"></a>00197 std::size_t prune_connections(<span class="keywordtype">void</span>);
<a name="l00198"></a>00198
<a name="l00199"></a>00199
<a name="l00201"></a>00201 <span class="keyword">typedef</span> std::set<tcp::connection_ptr> ConnectionPool;
<a name="l00202"></a>00202
<a name="l00203"></a>00203
<a name="l00205"></a>00205 <a class="code" href="classpion_1_1single__service__scheduler.html">single_service_scheduler</a> m_default_scheduler;
<a name="l00206"></a>00206
<a name="l00208"></a>00208 <a class="code" href="classpion_1_1scheduler.html">scheduler</a> & m_active_scheduler;
<a name="l00209"></a>00209
<a name="l00211"></a>00211 boost::asio::ip::tcp::acceptor m_tcp_acceptor;
<a name="l00212"></a>00212
<a name="l00214"></a>00214 <a class="code" href="classpion_1_1tcp_1_1connection.html#ae3e4aa69cacf69d2b9907dbda79b1f54" title="data type for SSL configuration context">connection::ssl_context_type</a> m_ssl_context;
<a name="l00215"></a>00215
<a name="l00217"></a>00217 boost::condition m_server_has_stopped;
<a name="l00218"></a>00218
<a name="l00220"></a>00220 boost::condition m_no_more_connections;
<a name="l00221"></a>00221
<a name="l00223"></a>00223 ConnectionPool m_conn_pool;
<a name="l00224"></a>00224
<a name="l00226"></a>00226 boost::asio::ip::tcp::endpoint m_endpoint;
<a name="l00227"></a>00227
<a name="l00229"></a>00229 <span class="keywordtype">bool</span> m_ssl_flag;
<a name="l00230"></a>00230
<a name="l00232"></a>00232 <span class="keywordtype">bool</span> m_is_listening;
<a name="l00233"></a>00233
<a name="l00235"></a>00235 <span class="keyword">mutable</span> boost::mutex m_mutex;
<a name="l00236"></a>00236 };
<a name="l00237"></a>00237
<a name="l00238"></a>00238
<a name="l00240"></a>00240 <span class="keyword">typedef</span> boost::shared_ptr<server> server_ptr;
<a name="l00241"></a>00241
<a name="l00242"></a>00242
<a name="l00243"></a>00243 } <span class="comment">// end namespace tcp</span>
<a name="l00244"></a>00244 } <span class="comment">// end namespace pion</span>
<a name="l00245"></a>00245
<a name="l00246"></a>00246 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 16 Sep 2013 for pion by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
|