Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > ed376d6842ea322c25405e7c23b3bc12 > files > 336

libcommoncpp-devel-1.8.0-5.1mdv2010.1.i586.rpm

<!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>GNU CommonC++: ost::SimpleTCPStream 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="index.html"><span>Main&nbsp;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>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_simple_t_c_p_stream.html">SimpleTCPStream</a>
  </div>
</div>
<div class="contents">
<h1>ost::SimpleTCPStream Class Reference</h1><!-- doxytag: class="ost::SimpleTCPStream" --><!-- doxytag: inherits="ost::Socket" -->
<p>Simple TCP Stream, to be used with Common C++ Library.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="socket_8h_source.html">socket.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ost::SimpleTCPStream:</div>
<div class="dynsection">
 <div class="center">
  <img src="classost_1_1_simple_t_c_p_stream.png" usemap="#ost::SimpleTCPStream_map" alt=""/>
  <map id="ost::SimpleTCPStream_map" name="ost::SimpleTCPStream_map">
<area href="classost_1_1_socket.html" alt="ost::Socket" shape="rect" coords="0,0,134,24"/>
</map>
 </div>
</div>

<p><a href="classost_1_1_simple_t_c_p_stream-members.html">List of all members.</a></p>
<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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_simple_t_c_p_stream.html#adbd39bbb1872fdcb5e183d495b77d803">SimpleTCPStream</a> (<a class="el" href="classost_1_1_t_c_p_socket.html">TCPSocket</a> &amp;server, size_t size=512)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a TCP stream by accepting a connection from a bound TCP socket acting as a server.  <a href="#adbd39bbb1872fdcb5e183d495b77d803"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_simple_t_c_p_stream.html#a097c7d9a1ea8b74f0044f14097ea7590">SimpleTCPStream</a> (const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> &amp;host, <a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port, size_t size=512)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a TCP stream by connecting to a TCP socket (on a remote machine).  <a href="#a097c7d9a1ea8b74f0044f14097ea7590"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_simple_t_c_p_stream.html#a9f5395676f24a75e7342aa1dcd5612c5">SimpleTCPStream</a> (const <a class="el" href="classost_1_1_simple_t_c_p_stream.html">SimpleTCPStream</a> &amp;source)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A copy constructor creates a new stream buffer.  <a href="#a9f5395676f24a75e7342aa1dcd5612c5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_simple_t_c_p_stream.html#a5871b832e999b5246d7116481aebbcbc">~SimpleTCPStream</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Flush and empty all buffers, and then remove the allocated buffers.  <a href="#a5871b832e999b5246d7116481aebbcbc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_simple_t_c_p_stream.html#a74b4194473dc3e76fd85d35930530d16">isPending</a> (<a class="el" href="classost_1_1_socket.html#a2cb9ccad21fc2f10c23e45cbb99bc6f8">Pending</a> pend, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=TIMEOUT_INF)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the status of pending stream data.  <a href="#a74b4194473dc3e76fd85d35930530d16"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_simple_t_c_p_stream.html#a50cdae078469b3876506ca4408f69705">flush</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ssize_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_simple_t_c_p_stream.html#a582017e7f3c30d32b05eb68fbbb8ea1a">read</a> (char *bytes, size_t length, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read bytes into a buffer.  <a href="#a582017e7f3c30d32b05eb68fbbb8ea1a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ssize_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_simple_t_c_p_stream.html#a671428f4e3ac21ca194dc7078b9e9489">write</a> (const char *bytes, size_t length, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write bytes to buffer.  <a href="#a671428f4e3ac21ca194dc7078b9e9489"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ssize_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_simple_t_c_p_stream.html#a9beccece67bd498cbe82752dac492325">peek</a> (char *bytes, size_t length, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Peek at the incoming data.  <a href="#a9beccece67bd498cbe82752dac492325"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_simple_t_c_p_stream.html#a6b67fa40f1d1154f12a26c082bbb10a8">SimpleTCPStream</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The constructor required for "SimpleTCPStream", a more C++ style version of the <a class="el" href="classost_1_1_simple_t_c_p_stream.html" title="Simple TCP Stream, to be used with Common C++ Library.">SimpleTCPStream</a> class.  <a href="#a6b67fa40f1d1154f12a26c082bbb10a8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_simple_t_c_p_stream.html#afab6a9450b949fe1093d8b63bc343c45">endStream</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Used to terminate the buffer space and cleanup the socket connection.  <a href="#afab6a9450b949fe1093d8b63bc343c45"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_simple_t_c_p_stream.html#a8c1f910e36329b69b868d062150d9c58">Connect</a> (const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> &amp;host, <a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port, size_t size)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a TCP stream by connecting to a TCP socket (on a remote machine).  <a href="#a8c1f910e36329b69b868d062150d9c58"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Simple TCP Stream, to be used with Common C++ Library. </p>
<p>This source is derived from a proposal made by Ville Vainio (<a href="mailto:vvainio@tp.spt.fi">vvainio@tp.spt.fi</a>).</p>
<dl class="author"><dt><b>Author:</b></dt><dd>Mark S. Millard (<a href="mailto:msm@wizzer.com">msm@wizzer.com</a>) </dd></dl>
<dl class="date"><dt><b>Date:</b></dt><dd>2002-08-15 Copyright (C) 2002 Wizzer Works. </dd></dl>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a6b67fa40f1d1154f12a26c082bbb10a8"></a><!-- doxytag: member="ost::SimpleTCPStream::SimpleTCPStream" ref="a6b67fa40f1d1154f12a26c082bbb10a8" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ost::SimpleTCPStream::SimpleTCPStream </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The constructor required for "SimpleTCPStream", a more C++ style version of the <a class="el" href="classost_1_1_simple_t_c_p_stream.html" title="Simple TCP Stream, to be used with Common C++ Library.">SimpleTCPStream</a> class. </p>

</div>
</div>
<a class="anchor" id="adbd39bbb1872fdcb5e183d495b77d803"></a><!-- doxytag: member="ost::SimpleTCPStream::SimpleTCPStream" ref="adbd39bbb1872fdcb5e183d495b77d803" args="(TCPSocket &amp;server, size_t size=512)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ost::SimpleTCPStream::SimpleTCPStream </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classost_1_1_t_c_p_socket.html">TCPSocket</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>server</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em> = <code>512</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Create a TCP stream by accepting a connection from a bound TCP socket acting as a server. </p>
<p>This performs an "accept" call.</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>&nbsp;</td><td>bound server tcp socket. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>of streaming input and output buffers. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a097c7d9a1ea8b74f0044f14097ea7590"></a><!-- doxytag: member="ost::SimpleTCPStream::SimpleTCPStream" ref="a097c7d9a1ea8b74f0044f14097ea7590" args="(const IPV4Host &amp;host, tpport_t port, size_t size=512)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ost::SimpleTCPStream::SimpleTCPStream </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>host</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a>&nbsp;</td>
          <td class="paramname"> <em>port</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em> = <code>512</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Create a TCP stream by connecting to a TCP socket (on a remote machine). </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>&nbsp;</td><td>address of remote TCP server. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>port</em>&nbsp;</td><td>number to connect. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>of streaming input and output buffers. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a9f5395676f24a75e7342aa1dcd5612c5"></a><!-- doxytag: member="ost::SimpleTCPStream::SimpleTCPStream" ref="a9f5395676f24a75e7342aa1dcd5612c5" args="(const SimpleTCPStream &amp;source)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ost::SimpleTCPStream::SimpleTCPStream </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classost_1_1_simple_t_c_p_stream.html">SimpleTCPStream</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>source</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>A copy constructor creates a new stream buffer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>A reference to the <a class="el" href="classost_1_1_simple_t_c_p_stream.html" title="Simple TCP Stream, to be used with Common C++ Library.">SimpleTCPStream</a> to copy. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a5871b832e999b5246d7116481aebbcbc"></a><!-- doxytag: member="ost::SimpleTCPStream::~SimpleTCPStream" ref="a5871b832e999b5246d7116481aebbcbc" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual ost::SimpleTCPStream::~SimpleTCPStream </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Flush and empty all buffers, and then remove the allocated buffers. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a8c1f910e36329b69b868d062150d9c58"></a><!-- doxytag: member="ost::SimpleTCPStream::Connect" ref="a8c1f910e36329b69b868d062150d9c58" args="(const IPV4Host &amp;host, tpport_t port, size_t size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ost::SimpleTCPStream::Connect </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>host</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a>&nbsp;</td>
          <td class="paramname"> <em>port</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Create a TCP stream by connecting to a TCP socket (on a remote machine). </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>&nbsp;</td><td>address of remote TCP server. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>port</em>&nbsp;</td><td>number to connect. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>of streaming input and output buffers. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="afab6a9450b949fe1093d8b63bc343c45"></a><!-- doxytag: member="ost::SimpleTCPStream::endStream" ref="afab6a9450b949fe1093d8b63bc343c45" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ost::SimpleTCPStream::endStream </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Used to terminate the buffer space and cleanup the socket connection. </p>
<p>This fucntion is called by the destructor. </p>

</div>
</div>
<a class="anchor" id="a50cdae078469b3876506ca4408f69705"></a><!-- doxytag: member="ost::SimpleTCPStream::flush" ref="a50cdae078469b3876506ca4408f69705" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ost::SimpleTCPStream::flush </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a74b4194473dc3e76fd85d35930530d16"></a><!-- doxytag: member="ost::SimpleTCPStream::isPending" ref="a74b4194473dc3e76fd85d35930530d16" args="(Pending pend, timeout_t timeout=TIMEOUT_INF)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ost::SimpleTCPStream::isPending </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classost_1_1_socket.html#a2cb9ccad21fc2f10c23e45cbb99bc6f8">Pending</a>&nbsp;</td>
          <td class="paramname"> <em>pend</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a>&nbsp;</td>
          <td class="paramname"> <em>timeout</em> = <code>TIMEOUT_INF</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get the status of pending stream data. </p>
<p>This method can be used to examine if input or output is waiting, or if an error or disconnect has occured on the stream. If a read buffer contains data then input is ready. If write buffer contains data, it is first flushed and then checked.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>pend</em>&nbsp;</td><td>Flag indicating means to pend. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>timeout</em>&nbsp;</td><td>The length of time to wait. </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented from <a class="el" href="classost_1_1_socket.html#a8eb84be4b5cc91731c16be4f32f5bf3d">ost::Socket</a>.</p>

</div>
</div>
<a class="anchor" id="a9beccece67bd498cbe82752dac492325"></a><!-- doxytag: member="ost::SimpleTCPStream::peek" ref="a9beccece67bd498cbe82752dac492325" args="(char *bytes, size_t length, timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ssize_t ost::SimpleTCPStream::peek </td>
          <td>(</td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>bytes</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>length</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a>&nbsp;</td>
          <td class="paramname"> <em>timeout</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Peek at the incoming data. </p>
<p>The data is copied into the buffer but is not removed from the input queue. The function then returns the number of bytes currently pending to receive.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>bytes</em>&nbsp;</td><td>A pointer to buffer that will contain the bytes read. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>The number of bytes to read (exactly). </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>timeout</em>&nbsp;</td><td>Period to time out, in milleseconds.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of bytes pending on the input queue, 0 on EOF. </dd></dl>

</div>
</div>
<a class="anchor" id="a582017e7f3c30d32b05eb68fbbb8ea1a"></a><!-- doxytag: member="ost::SimpleTCPStream::read" ref="a582017e7f3c30d32b05eb68fbbb8ea1a" args="(char *bytes, size_t length, timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ssize_t ost::SimpleTCPStream::read </td>
          <td>(</td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>bytes</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>length</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a>&nbsp;</td>
          <td class="paramname"> <em>timeout</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Read bytes into a buffer. </p>
<p>&lt;long-description&gt;</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>bytes</em>&nbsp;</td><td>A pointer to buffer that will contain the bytes read. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>The number of bytes to read (exactly). </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>timeout</em>&nbsp;</td><td>Period to time out, in milleseconds.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of bytes actually read, 0 on EOF. </dd></dl>

</div>
</div>
<a class="anchor" id="a671428f4e3ac21ca194dc7078b9e9489"></a><!-- doxytag: member="ost::SimpleTCPStream::write" ref="a671428f4e3ac21ca194dc7078b9e9489" args="(const char *bytes, size_t length, timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ssize_t ost::SimpleTCPStream::write </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>bytes</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>length</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a>&nbsp;</td>
          <td class="paramname"> <em>timeout</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Write bytes to buffer. </p>
<p>&lt;long-description&gt;</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>bytes</em>&nbsp;</td><td>A pointer to a buffer containing the bytes to write. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>The number of bytes to write (exactly). </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>timeout</em>&nbsp;</td><td>Period to time out, in milleseconds.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of bytes actually written. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="socket_8h_source.html">socket.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:55:47 2010 for GNU CommonC++ by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional