<!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>ucommon: TCPBuffer Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.3 --> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">ucommon</div> </td> </tr> </tbody> </table> </div> <div id="navrow1" class="tabs"> <ul class="tablist"> <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>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="classes.html"><span>Data Structure Index</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Data Fields</span></a></li> </ul> </div> </div> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> initNavTree('a00153.html',''); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> </div> <div class="headertitle"> <h1>TCPBuffer Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="TCPBuffer" --><!-- doxytag: inherits="BufferProtocol,Socket" --> <p>A generic tcp socket class that offers i/o buffering. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="a00179_source.html">buffer.h</a>></code></p> <div class="dynheader"> Inheritance diagram for TCPBuffer:</div> <div class="dyncontent"> <div class="center"><img src="a00482.png" border="0" usemap="#_t_c_p_buffer_inherit__map" alt="Inheritance graph"/></div> <map name="_t_c_p_buffer_inherit__map" id="_t_c_p_buffer_inherit__map"> <area shape="rect" id="node9" href="a00145.html" title="Secure socket buffer." alt="" coords="119,229,231,256"/><area shape="rect" id="node2" href="a00026.html" title="Common buffer protocol class." alt="" coords="20,80,183,107"/><area shape="rect" id="node4" href="a00028.html" title="Common character processing protocol." alt="" coords="5,5,197,32"/><area shape="rect" id="node6" href="a00142.html" title="A generic socket base class." alt="" coords="207,80,289,107"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <div class="dynheader"> Collaboration diagram for TCPBuffer:</div> <div class="dyncontent"> <div class="center"><img src="a00483.png" border="0" usemap="#_t_c_p_buffer_coll__map" alt="Collaboration graph"/></div> <map name="_t_c_p_buffer_coll__map" id="_t_c_p_buffer_coll__map"> <area shape="rect" id="node2" href="a00026.html" title="Common buffer protocol class." alt="" coords="20,80,183,107"/><area shape="rect" id="node4" href="a00028.html" title="Common character processing protocol." alt="" coords="5,5,197,32"/><area shape="rect" id="node6" href="a00142.html" title="A generic socket base class." alt="" coords="207,80,289,107"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a51a74cb9fb4cf9330e9a02338cd7f6ab"></a><!-- doxytag: member="TCPBuffer::close" ref="a51a74cb9fb4cf9330e9a02338cd7f6ab" args="(void)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#a51a74cb9fb4cf9330e9a02338cd7f6ab">close</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Close active connection. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#a08ce125780d6b7cc8f210c6886380b78">open</a> (const char *host, const char *service, size_t size=536)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Connect a tcp client session to a specific host uri. <a href="#a08ce125780d6b7cc8f210c6886380b78"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#a93de2033838ffa75def928fa2f0481c3">open</a> (const <a class="el" href="a00154.html">TCPServer</a> *server, size_t size=536)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Connect a tcp socket to a client from a listener. <a href="#a93de2033838ffa75def928fa2f0481c3"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#ab66f151c4da45b11931bc539d89c9ce8">TCPBuffer</a> (const <a class="el" href="a00154.html">TCPServer</a> *server, size_t size=536)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a tcp server session from a listening socket. <a href="#ab66f151c4da45b11931bc539d89c9ce8"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa0595b3edd85e672f1b82b52fa611de0"></a><!-- doxytag: member="TCPBuffer::TCPBuffer" ref="aa0595b3edd85e672f1b82b52fa611de0" args="()" -->  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#aa0595b3edd85e672f1b82b52fa611de0">TCPBuffer</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an unconnected tcp client and specify our service profile. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#a3458f6ee3af76f5c69f69d3d6078f8fa">TCPBuffer</a> (const char *host, const char *service, size_t size=536)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a tcp client session connected to a specific host uri. <a href="#a3458f6ee3af76f5c69f69d3d6078f8fa"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6e3fc6dbc13d8ab870a6783065e222ed"></a><!-- doxytag: member="TCPBuffer::~TCPBuffer" ref="a6e3fc6dbc13d8ab870a6783065e222ed" args="()" --> virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#a6e3fc6dbc13d8ab870a6783065e222ed">~TCPBuffer</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy the tcp socket and release all resources. <br/></td></tr> <tr><td colspan="2"><h2><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac251e589c325ccf358ea8e61ab59f05a"></a><!-- doxytag: member="TCPBuffer::_blocking" ref="ac251e589c325ccf358ea8e61ab59f05a" args="(void)" --> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#ac251e589c325ccf358ea8e61ab59f05a">_blocking</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if blocking. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc3409daec4576fc5a2ab070eaf673cc"></a><!-- doxytag: member="TCPBuffer::_buffer" ref="abc3409daec4576fc5a2ab070eaf673cc" args="(size_t size)" --> void </td><td class="memItemRight" valign="bottom"><b>_buffer</b> (size_t size)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a225f279dd64437a89ca404721da5eac4"></a><!-- doxytag: member="TCPBuffer::_clear" ref="a225f279dd64437a89ca404721da5eac4" args="(void)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#a225f279dd64437a89ca404721da5eac4">_clear</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Method to clear low level i/o error. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#a8b3f5bdb588264bbbb911b2bf1a18217">_err</a> (void) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Method to get low level i/o error. <a href="#a8b3f5bdb588264bbbb911b2bf1a18217"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#a766e77cf12b658ae1800aeab8971ae08">_pending</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Check for pending tcp or ssl data. <a href="#a766e77cf12b658ae1800aeab8971ae08"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#a155afa24d6928913be7706060542aae8">_pull</a> (char *<a class="el" href="a00143.html">address</a>, size_t size)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Method to pull buffer from physical i/o (read). <a href="#a155afa24d6928913be7706060542aae8"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#a158f7e96e02a0b41c816745b03c27f2d">_push</a> (const char *<a class="el" href="a00143.html">address</a>, size_t size)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Method to push buffer into physical i/o (write). <a href="#a158f7e96e02a0b41c816745b03c27f2d"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">socket_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#a5f753fb25ef6eb9f3a232d82982ce9a2">getsocket</a> (void) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the low level socket object. <a href="#a5f753fb25ef6eb9f3a232d82982ce9a2"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <div class="textblock"><p>A generic tcp socket class that offers i/o buffering. </p> <p>All user i/o operations are directly inherited from the IOBuffer base class public members. Some additional members are added for layering ssl services. </p> <dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl> <p>Definition at line <a class="el" href="a00179_source.html#l00151">151</a> of file <a class="el" href="a00179_source.html">buffer.h</a>.</p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="ab66f151c4da45b11931bc539d89c9ce8"></a><!-- doxytag: member="TCPBuffer::TCPBuffer" ref="ab66f151c4da45b11931bc539d89c9ce8" args="(const TCPServer *server, size_t size=536)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">TCPBuffer::TCPBuffer </td> <td>(</td> <td class="paramtype">const <a class="el" href="a00154.html">TCPServer</a> * </td> <td class="paramname"><em>server</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>size</em> = <code>536</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Construct a tcp server session from a listening socket. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">server</td><td>socket we are created from. </td></tr> <tr><td class="paramname">size</td><td>of buffer and tcp fragments. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a3458f6ee3af76f5c69f69d3d6078f8fa"></a><!-- doxytag: member="TCPBuffer::TCPBuffer" ref="a3458f6ee3af76f5c69f69d3d6078f8fa" args="(const char *host, const char *service, size_t size=536)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">TCPBuffer::TCPBuffer </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>host</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>service</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>size</em> = <code>536</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Construct a tcp client session connected to a specific host uri. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">host</td><td>and optional :port we are connecting to. </td></tr> <tr><td class="paramname">service</td><td>identifier of our client. </td></tr> <tr><td class="paramname">size</td><td>of buffer and tcp fragments. </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a8b3f5bdb588264bbbb911b2bf1a18217"></a><!-- doxytag: member="TCPBuffer::_err" ref="a8b3f5bdb588264bbbb911b2bf1a18217" args="(void) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int TCPBuffer::_err </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const<code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Method to get low level i/o error. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>error from low level i/o methods. </dd></dl> <p>Implements <a class="el" href="a00026.html#adb9d25e9827e64994be51a3764d220cb">BufferProtocol</a>.</p> </div> </div> <a class="anchor" id="a766e77cf12b658ae1800aeab8971ae08"></a><!-- doxytag: member="TCPBuffer::_pending" ref="a766e77cf12b658ae1800aeab8971ae08" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool TCPBuffer::_pending </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Check for pending tcp or ssl data. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>true if data pending. </dd></dl> <p>Reimplemented from <a class="el" href="a00026.html#a8d2bcc8a640ceaa8adc06ff4201b4bf7">BufferProtocol</a>.</p> <p>Reimplemented in <a class="el" href="a00145.html#afec60a07fb94c439d1b3685090353f99">SSLBuffer</a>.</p> </div> </div> <a class="anchor" id="a155afa24d6928913be7706060542aae8"></a><!-- doxytag: member="TCPBuffer::_pull" ref="a155afa24d6928913be7706060542aae8" args="(char *address, size_t size)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual size_t TCPBuffer::_pull </td> <td>(</td> <td class="paramtype">char * </td> <td class="paramname"><em>address</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>size</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Method to pull buffer from physical i/o (read). </p> <p>The address is passed to this virtual since it is hidden as private. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">address</td><td>of buffer to pull data into. </td></tr> <tr><td class="paramname">size</td><td>of buffer area being pulled.. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>number of read written, 0 on error or end of data. </dd></dl> <p>Implements <a class="el" href="a00026.html#ad2c4021277a1302c3e622a168da7a040">BufferProtocol</a>.</p> <p>Reimplemented in <a class="el" href="a00145.html#abe442464247c1c091880c70a6318209e">SSLBuffer</a>.</p> </div> </div> <a class="anchor" id="a158f7e96e02a0b41c816745b03c27f2d"></a><!-- doxytag: member="TCPBuffer::_push" ref="a158f7e96e02a0b41c816745b03c27f2d" args="(const char *address, size_t size)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual size_t TCPBuffer::_push </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>address</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>size</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Method to push buffer into physical i/o (write). </p> <p>The address is passed to this virtual since it is hidden as private. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">address</td><td>of data to push. </td></tr> <tr><td class="paramname">size</td><td>of data to push. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>number of bytes written, 0 on error. </dd></dl> <p>Implements <a class="el" href="a00026.html#a1eab001b291a96fe9ef6e018becad29c">BufferProtocol</a>.</p> <p>Reimplemented in <a class="el" href="a00145.html#aeadbbb7391f8c72acb727028dc3718c5">SSLBuffer</a>.</p> </div> </div> <a class="anchor" id="a5f753fb25ef6eb9f3a232d82982ce9a2"></a><!-- doxytag: member="TCPBuffer::getsocket" ref="a5f753fb25ef6eb9f3a232d82982ce9a2" args="(void) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">socket_t TCPBuffer::getsocket </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const<code> [inline, protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Get the low level socket object. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>socket we are using. </dd></dl> <p>Definition at line <a class="el" href="a00179_source.html#l00166">166</a> of file <a class="el" href="a00179_source.html">buffer.h</a>.</p> </div> </div> <a class="anchor" id="a08ce125780d6b7cc8f210c6886380b78"></a><!-- doxytag: member="TCPBuffer::open" ref="a08ce125780d6b7cc8f210c6886380b78" args="(const char *host, const char *service, size_t size=536)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void TCPBuffer::open </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>host</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>service</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>size</em> = <code>536</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Connect a tcp client session to a specific host uri. </p> <p>If the socket was already connected, it is automatically closed first. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">host</td><td>we are connecting. </td></tr> <tr><td class="paramname">service</td><td>to connect to. </td></tr> <tr><td class="paramname">size</td><td>of buffer and tcp fragments. </td></tr> </table> </dd> </dl> <p>Reimplemented in <a class="el" href="a00145.html#a0c6720bb0ab8c23191b13d526fe9f4e1">SSLBuffer</a>.</p> </div> </div> <a class="anchor" id="a93de2033838ffa75def928fa2f0481c3"></a><!-- doxytag: member="TCPBuffer::open" ref="a93de2033838ffa75def928fa2f0481c3" args="(const TCPServer *server, size_t size=536)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void TCPBuffer::open </td> <td>(</td> <td class="paramtype">const <a class="el" href="a00154.html">TCPServer</a> * </td> <td class="paramname"><em>server</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>size</em> = <code>536</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Connect a tcp socket to a client from a listener. </p> <p>If the socket was already connected, it is automatically closed first. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">server</td><td>we are connected from. </td></tr> <tr><td class="paramname">size</td><td>of buffer and tcp fragments. </td></tr> </table> </dd> </dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>ucommon/<a class="el" href="a00179_source.html">buffer.h</a></li> </ul> </div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="a00153.html">TCPBuffer</a> </li> <li class="footer">Generated on Wed Apr 13 2011 22:39:48 for ucommon by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li> </ul> </div> </body> </html>