<!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: ucommon::TCPBuffer Class Reference</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.3 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="main.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 class="tabs"> <ul> <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="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Data Fields</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="a00208.html">ucommon</a>::<a class="el" href="a00151.html">TCPBuffer</a> </div> </div> <div class="contents"> <h1>ucommon::TCPBuffer Class Reference</h1><!-- doxytag: class="ucommon::TCPBuffer" --><!-- doxytag: inherits="ucommon::BufferProtocol,ucommon::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="a00180_source.html">buffer.h</a>></code></p> <div class="dynheader"> Inheritance diagram for ucommon::TCPBuffer:</div> <div class="dynsection"> <div class="center"><img src="a00545.png" border="0" usemap="#ucommon_1_1_t_c_p_buffer_inherit__map" alt="Inheritance graph"/></div> <map name="ucommon_1_1_t_c_p_buffer_inherit__map" id="ucommon_1_1_t_c_p_buffer_inherit__map"> <area shape="rect" id="node9" href="a00143.html" title="Secure socket buffer." alt="" coords="163,229,365,256"/><area shape="rect" id="node2" href="a00028.html" title="Common buffer protocol class." alt="" coords="21,80,272,107"/><area shape="rect" id="node4" href="a00030.html" title="Common character processing protocol." alt="" coords="5,5,288,32"/><area shape="rect" id="node6" href="a00140.html" title="A generic socket base class." alt="" coords="296,80,467,107"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <div class="dynheader"> Collaboration diagram for ucommon::TCPBuffer:</div> <div class="dynsection"> <div class="center"><img src="a00546.png" border="0" usemap="#ucommon_1_1_t_c_p_buffer_coll__map" alt="Collaboration graph"/></div> <map name="ucommon_1_1_t_c_p_buffer_coll__map" id="ucommon_1_1_t_c_p_buffer_coll__map"> <area shape="rect" id="node2" href="a00028.html" title="Common buffer protocol class." alt="" coords="21,80,272,107"/><area shape="rect" id="node4" href="a00030.html" title="Common character processing protocol." alt="" coords="5,5,288,32"/><area shape="rect" id="node6" href="a00140.html" title="A generic socket base class." alt="" coords="296,80,467,107"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2bdb30778e3b33a50147bd45a1473c7d"></a><!-- doxytag: member="ucommon::TCPBuffer::close" ref="a2bdb30778e3b33a50147bd45a1473c7d" args="(void)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00151.html#a2bdb30778e3b33a50147bd45a1473c7d">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="a00151.html#a4fac2eaa04264d57382f682b65165bd8">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="#a4fac2eaa04264d57382f682b65165bd8"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00151.html#a7447a200e455cf2df1077bc69ad43559">open</a> (const <a class="el" href="a00152.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="#a7447a200e455cf2df1077bc69ad43559"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00151.html#a1c6490bf22100dcbc0ccabb7cef81ad3">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="#a1c6490bf22100dcbc0ccabb7cef81ad3"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00151.html#ae0b2cfde099782ebd016d521f6056e9c">TCPBuffer</a> (const <a class="el" href="a00152.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="#ae0b2cfde099782ebd016d521f6056e9c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0612ebdf7ae15b418de23137ba4228ac"></a><!-- doxytag: member="ucommon::TCPBuffer::TCPBuffer" ref="a0612ebdf7ae15b418de23137ba4228ac" args="()" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00151.html#a0612ebdf7ae15b418de23137ba4228ac">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"><a class="anchor" id="ae716ff2e0083c5ba74b43c437b4cd53a"></a><!-- doxytag: member="ucommon::TCPBuffer::~TCPBuffer" ref="ae716ff2e0083c5ba74b43c437b4cd53a" args="()" --> virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00151.html#ae716ff2e0083c5ba74b43c437b4cd53a">~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>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e2077653666d91d207756b822085cf1"></a><!-- doxytag: member="ucommon::TCPBuffer::_blocking" ref="a7e2077653666d91d207756b822085cf1" args="(void)" --> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00151.html#a7e2077653666d91d207756b822085cf1">_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="a256cee48158631ffd6078c21ea1d290c"></a><!-- doxytag: member="ucommon::TCPBuffer::_buffer" ref="a256cee48158631ffd6078c21ea1d290c" 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="adbb9a35dee6944fe0281d711fe319833"></a><!-- doxytag: member="ucommon::TCPBuffer::_clear" ref="adbb9a35dee6944fe0281d711fe319833" args="(void)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00151.html#adbb9a35dee6944fe0281d711fe319833">_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="a00151.html#a93a6dc195313a3499f46216d984765f2">_err</a> (void) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Method to get low level i/o error. <a href="#a93a6dc195313a3499f46216d984765f2"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00151.html#ab216fea2b8230fb897ab0d7954f2a4e3">_pending</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Check for pending tcp or ssl data. <a href="#ab216fea2b8230fb897ab0d7954f2a4e3"></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="a00151.html#aa707a8eafa0360cf7318fe12444ccbb6">_pull</a> (char *<a class="el" href="a00141.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="#aa707a8eafa0360cf7318fe12444ccbb6"></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="a00151.html#ab7dd00490127cc7eb1fa194f6fe90f6f">_push</a> (const char *<a class="el" href="a00141.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="#ab7dd00490127cc7eb1fa194f6fe90f6f"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">socket_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00151.html#a951a962fea0f2a09ad9236b9c43a67f9">getsocket</a> (void) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the low level socket object. <a href="#a951a962fea0f2a09ad9236b9c43a67f9"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <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="a00180_source.html#l00151">151</a> of file <a class="el" href="a00180_source.html">buffer.h</a>.</p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="ae0b2cfde099782ebd016d521f6056e9c"></a><!-- doxytag: member="ucommon::TCPBuffer::TCPBuffer" ref="ae0b2cfde099782ebd016d521f6056e9c" args="(const TCPServer *server, size_t size=536)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ucommon::TCPBuffer::TCPBuffer </td> <td>(</td> <td class="paramtype">const <a class="el" href="a00152.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><td> </td> </tr> <tr> <td></td> <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 border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>server</em> </td><td>socket we are created from. </td></tr> <tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of buffer and tcp fragments. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a1c6490bf22100dcbc0ccabb7cef81ad3"></a><!-- doxytag: member="ucommon::TCPBuffer::TCPBuffer" ref="a1c6490bf22100dcbc0ccabb7cef81ad3" args="(const char *host, const char *service, size_t size=536)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ucommon::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><td> </td> </tr> <tr> <td></td> <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 border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>host</em> </td><td>and optional :port we are connecting to. </td></tr> <tr><td valign="top"></td><td valign="top"><em>service</em> </td><td>identifier of our client. </td></tr> <tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of buffer and tcp fragments. </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a93a6dc195313a3499f46216d984765f2"></a><!-- doxytag: member="ucommon::TCPBuffer::_err" ref="a93a6dc195313a3499f46216d984765f2" args="(void) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int ucommon::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="a00028.html#a5f0923302702e561a3c615873ba1fe89">ucommon::BufferProtocol</a>.</p> </div> </div> <a class="anchor" id="ab216fea2b8230fb897ab0d7954f2a4e3"></a><!-- doxytag: member="ucommon::TCPBuffer::_pending" ref="ab216fea2b8230fb897ab0d7954f2a4e3" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool ucommon::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="a00028.html#a0bff400bc09929b1c771bf962c91b7af">ucommon::BufferProtocol</a>.</p> <p>Reimplemented in <a class="el" href="a00143.html#a72fa62f40ca59d9f0c96ee911033b223">ucommon::SSLBuffer</a>.</p> </div> </div> <a class="anchor" id="aa707a8eafa0360cf7318fe12444ccbb6"></a><!-- doxytag: member="ucommon::TCPBuffer::_pull" ref="aa707a8eafa0360cf7318fe12444ccbb6" args="(char *address, size_t size)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual size_t ucommon::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><td> </td> </tr> <tr> <td></td> <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 border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>address</em> </td><td>of buffer to pull data into. </td></tr> <tr><td valign="top"></td><td valign="top"><em>size</em> </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="a00028.html#ad9add3680f74ccacc47283a1b2a18b2f">ucommon::BufferProtocol</a>.</p> <p>Reimplemented in <a class="el" href="a00143.html#a7239ef8827aefec0584fb742808048ce">ucommon::SSLBuffer</a>.</p> </div> </div> <a class="anchor" id="ab7dd00490127cc7eb1fa194f6fe90f6f"></a><!-- doxytag: member="ucommon::TCPBuffer::_push" ref="ab7dd00490127cc7eb1fa194f6fe90f6f" args="(const char *address, size_t size)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual size_t ucommon::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><td> </td> </tr> <tr> <td></td> <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 border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>address</em> </td><td>of data to push. </td></tr> <tr><td valign="top"></td><td valign="top"><em>size</em> </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="a00028.html#a5329c45421a6d759d8a786c06edadb41">ucommon::BufferProtocol</a>.</p> <p>Reimplemented in <a class="el" href="a00143.html#af0cbe6e362a9285e512d9e7bfcb83356">ucommon::SSLBuffer</a>.</p> </div> </div> <a class="anchor" id="a951a962fea0f2a09ad9236b9c43a67f9"></a><!-- doxytag: member="ucommon::TCPBuffer::getsocket" ref="a951a962fea0f2a09ad9236b9c43a67f9" args="(void) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">socket_t ucommon::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="a00180_source.html#l00166">166</a> of file <a class="el" href="a00180_source.html">buffer.h</a>.</p> </div> </div> <a class="anchor" id="a4fac2eaa04264d57382f682b65165bd8"></a><!-- doxytag: member="ucommon::TCPBuffer::open" ref="a4fac2eaa04264d57382f682b65165bd8" 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 ucommon::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><td> </td> </tr> <tr> <td></td> <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 border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>host</em> </td><td>we are connecting. </td></tr> <tr><td valign="top"></td><td valign="top"><em>service</em> </td><td>to connect to. </td></tr> <tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of buffer and tcp fragments. </td></tr> </table> </dd> </dl> <p>Reimplemented in <a class="el" href="a00143.html#ad2d3981de1cb63a1b27a420db8eb1248">ucommon::SSLBuffer</a>.</p> </div> </div> <a class="anchor" id="a7447a200e455cf2df1077bc69ad43559"></a><!-- doxytag: member="ucommon::TCPBuffer::open" ref="a7447a200e455cf2df1077bc69ad43559" args="(const TCPServer *server, size_t size=536)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ucommon::TCPBuffer::open </td> <td>(</td> <td class="paramtype">const <a class="el" href="a00152.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><td> </td> </tr> <tr> <td></td> <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 border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>server</em> </td><td>we are connected from. </td></tr> <tr><td valign="top"></td><td valign="top"><em>size</em> </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="a00180_source.html">buffer.h</a></li> </ul> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:40:07 2011 for ucommon by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>