📄 classpion_1_1_t_c_p_connection.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"><title>libpion: pion::TCPConnection Class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"><link href="tabs.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.5.2 --><div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul></div><div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul></div><div class="nav"><a class="el" href="namespacepion.html">pion</a>::<a class="el" href="classpion_1_1_t_c_p_connection.html">TCPConnection</a></div><h1>pion::TCPConnection Class Reference</h1><!-- doxytag: class="pion::TCPConnection" --><code>#include <<a class="el" href="_t_c_p_connection_8hpp-source.html">TCPConnection.hpp</a>></code><p><a href="classpion_1_1_t_c_p_connection-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2><a class="el" href="classpion_1_1_t_c_p_connection.html">TCPConnection</a>: represents a single tcp connection <p><p>Definition at line <a class="el" href="_t_c_p_connection_8hpp-source.html#l00031">31</a> of file <a class="el" href="_t_c_p_connection_8hpp-source.html">TCPConnection.hpp</a>.<table border="0" cellpadding="0" cellspacing="0"><tr><td></td></tr><tr><td colspan="2"><br><h2>Public Types</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="028b488e4cf66b86d7de3caa2e31c67d"></a><!-- doxytag: member="pion::TCPConnection::ConnectionHandler" ref="028b488e4cf66b86d7de3caa2e31c67d" args="" -->typedef boost::function1<<br> void, boost::shared_ptr<<br> <a class="el" href="classpion_1_1_t_c_p_connection.html">TCPConnection</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_t_c_p_connection.html#028b488e4cf66b86d7de3caa2e31c67d">ConnectionHandler</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">data type for a function that handles TCP connection objects <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b31f3051560000964ed3f611f28e0df5"></a><!-- doxytag: member="pion::TCPConnection::Socket" ref="b31f3051560000964ed3f611f28e0df5" args="" -->typedef boost::asio::ip::tcp::socket </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_t_c_p_connection.html#b31f3051560000964ed3f611f28e0df5">Socket</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">data type for a socket connection <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0f6f0c195193309acefca96ad3e9419f"></a><!-- doxytag: member="pion::TCPConnection::SSLSocket" ref="0f6f0c195193309acefca96ad3e9419f" args="" -->typedef <a class="el" href="classpion_1_1_t_c_p_connection.html#b31f3051560000964ed3f611f28e0df5">Socket</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_t_c_p_connection.html#0f6f0c195193309acefca96ad3e9419f">SSLSocket</a></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7847013e92aa594ac6a7ce9d8ceaf1c2"></a><!-- doxytag: member="pion::TCPConnection::SSLContext" ref="7847013e92aa594ac6a7ce9d8ceaf1c2" args="" -->typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_t_c_p_connection.html#7847013e92aa594ac6a7ce9d8ceaf1c2">SSLContext</a></td></tr><tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67a65ee19661e809f4e4b369abe226d0"></a><!-- doxytag: member="pion::TCPConnection::~TCPConnection" ref="67a65ee19661e809f4e4b369abe226d0" args="()" -->virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_t_c_p_connection.html#67a65ee19661e809f4e4b369abe226d0">~TCPConnection</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">virtual destructor <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7f71a359506ed1af3ec481ebffb7d599"></a><!-- doxytag: member="pion::TCPConnection::close" ref="7f71a359506ed1af3ec481ebffb7d599" args="(void)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_t_c_p_connection.html#7f71a359506ed1af3ec481ebffb7d599">close</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">closes the tcp socket <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_t_c_p_connection.html#5a83ed775fcb99cbcce42dd109ad06d4">finish</a> (void)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2ebb9e3e06969076b1ebc7b4d7487cc1"></a><!-- doxytag: member="pion::TCPConnection::getSSLFlag" ref="2ebb9e3e06969076b1ebc7b4d7487cc1" args="(void) const " -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_t_c_p_connection.html#2ebb9e3e06969076b1ebc7b4d7487cc1">getSSLFlag</a> (void) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns true if the connection is encrypted using SSL <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="85d7e745295c34dbf5c1536a23588cf8"></a><!-- doxytag: member="pion::TCPConnection::getSocket" ref="85d7e745295c34dbf5c1536a23588cf8" args="(void)" --><a class="el" href="classpion_1_1_t_c_p_connection.html#b31f3051560000964ed3f611f28e0df5">Socket</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_t_c_p_connection.html#85d7e745295c34dbf5c1536a23588cf8">getSocket</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns the socket associated with the TCP connection (non-SSL) <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="62cd3b634806423fb9cf008e10e85639"></a><!-- doxytag: member="pion::TCPConnection::getSSLSocket" ref="62cd3b634806423fb9cf008e10e85639" args="(void)" --><a class="el" href="classpion_1_1_t_c_p_connection.html#0f6f0c195193309acefca96ad3e9419f">SSLSocket</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_t_c_p_connection.html#62cd3b634806423fb9cf008e10e85639">getSSLSocket</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns the socket associated with the TCP connection (SSL) <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f1b6035f0b6c22a91cf83d1865173e5d"></a><!-- doxytag: member="pion::TCPConnection::getKeepAlive" ref="f1b6035f0b6c22a91cf83d1865173e5d" args="(void) const " -->bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_t_c_p_connection.html#f1b6035f0b6c22a91cf83d1865173e5d">getKeepAlive</a> (void) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns true if the connection should be kept alive <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cda3f717d79001dcd5868f28d077cf61"></a><!-- doxytag: member="pion::TCPConnection::setKeepAlive" ref="cda3f717d79001dcd5868f28d077cf61" args="(bool b=true)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_t_c_p_connection.html#cda3f717d79001dcd5868f28d077cf61">setKeepAlive</a> (bool b=true)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">sets the value of the keep_alive flag <br></td></tr><tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">static boost::shared_ptr<<br> <a class="el" href="classpion_1_1_t_c_p_connection.html">TCPConnection</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_t_c_p_connection.html#7a2e7e30840b48f7659a1c75d51a9f52">create</a> (boost::asio::io_service &io_service, <a class="el" href="classpion_1_1_t_c_p_connection.html#7847013e92aa594ac6a7ce9d8ceaf1c2">SSLContext</a> &ssl_context, const bool ssl_flag, <a class="el" href="classpion_1_1_t_c_p_connection.html#028b488e4cf66b86d7de3caa2e31c67d">ConnectionHandler</a> finished_handler)</td></tr><tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_t_c_p_connection.html#138a580b19ab6488e02e43dc05d3fe85">TCPConnection</a> (boost::asio::io_service &io_service, <a class="el" href="classpion_1_1_t_c_p_connection.html#7847013e92aa594ac6a7ce9d8ceaf1c2">SSLContext</a> &ssl_context, const bool ssl_flag, <a class="el" href="classpion_1_1_t_c_p_connection.html#028b488e4cf66b86d7de3caa2e31c67d">ConnectionHandler</a> finished_handler)</td></tr></table><hr><h2>Constructor & Destructor Documentation</h2><a class="anchor" name="138a580b19ab6488e02e43dc05d3fe85"></a><!-- doxytag: member="pion::TCPConnection::TCPConnection" ref="138a580b19ab6488e02e43dc05d3fe85" args="(boost::asio::io_service &io_service, SSLContext &ssl_context, const bool ssl_flag, ConnectionHandler finished_handler)" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">pion::TCPConnection::TCPConnection </td> <td>(</td> <td class="paramtype">boost::asio::io_service & </td> <td class="paramname"> <em>io_service</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classpion_1_1_t_c_p_connection.html#7847013e92aa594ac6a7ce9d8ceaf1c2">SSLContext</a> & </td> <td class="paramname"> <em>ssl_context</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const bool </td> <td class="paramname"> <em>ssl_flag</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -