<!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::TCPStream 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 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 List</span></a></li>
<li><a href="classes.html"><span>Class Index</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="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_t_c_p_stream.html">TCPStream</a>
</div>
</div>
<div class="contents">
<h1>ost::TCPStream Class Reference</h1><!-- doxytag: class="ost::TCPStream" --><!-- doxytag: inherits="ost::Socket" -->
<p>TCP streams are used to represent TCP client connections to a server by TCP protocol servers for accepting client connections.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="socket_8h_source.html">socket.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ost::TCPStream:</div>
<div class="dynsection">
<div class="center">
<img src="classost_1_1_t_c_p_stream.png" usemap="#ost::TCPStream_map" alt=""/>
<map id="ost::TCPStream_map" name="ost::TCPStream_map">
<area href="classost_1_1_socket.html" alt="ost::Socket" shape="rect" coords="112,0,214,24"/>
<area href="classost_1_1_s_s_l_stream.html" alt="ost::SSLStream" shape="rect" coords="0,112,102,136"/>
<area href="classost_1_1_t_c_p_session.html" alt="ost::TCPSession" shape="rect" coords="112,112,214,136"/>
<area href="classost_1_1_u_r_l_stream.html" alt="ost::URLStream" shape="rect" coords="224,112,326,136"/>
</map>
</div>
</div>
<p><a href="classost_1_1_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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#aa2ee8f719d30376c22ce9503baa9f43c">TCPStream</a> (<a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">Family</a> <a class="el" href="classost_1_1_t_c_p_stream.html#aecc5f6b34232ba0fef048f53fdaa51fc">family</a>=IPV4, bool throwflag=true, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> to=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The constructor required for building other classes or to start an unconnected <a class="el" href="classost_1_1_t_c_p_stream.html" title="TCP streams are used to represent TCP client connections to a server by TCP protocol...">TCPStream</a> for connect. <a href="#aa2ee8f719d30376c22ce9503baa9f43c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a465c1772f8b6c1e1effcdfdc248622af">disconnect</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disconnect the current session and prepare for a new one. <a href="#a465c1772f8b6c1e1effcdfdc248622af"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a4c5fac74099d34d067b075995f53b60a">getSegmentSize</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get protocol segment size. <a href="#a4c5fac74099d34d067b075995f53b60a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a8e008d40cdf19e3216cce66dfd084991">TCPStream</a> (<a class="el" href="classost_1_1_t_c_p_socket.html">TCPSocket</a> &server, bool throwflag=true, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> <a class="el" href="classost_1_1_t_c_p_stream.html#ae223ae380e2dc9d2e64cde0a577eccf2">timeout</a>=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a TCP stream by accepting a connection from a bound TCP socket acting as a server. <a href="#a8e008d40cdf19e3216cce66dfd084991"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a24bea89abbc213b6f60918ee233c6437">TCPStream</a> (<a class="el" href="classost_1_1_t_c_p_v6_socket.html">TCPV6Socket</a> &server, bool throwflag=true, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> <a class="el" href="classost_1_1_t_c_p_stream.html#ae223ae380e2dc9d2e64cde0a577eccf2">timeout</a>=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a75ef0dedbc6985ff113817a24cb8fc14">connect</a> (<a class="el" href="classost_1_1_t_c_p_socket.html">TCPSocket</a> &server)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Accept a connection from a TCP Server. <a href="#a75ef0dedbc6985ff113817a24cb8fc14"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#aba5de9163b215f181a43903099a8c403">connect</a> (<a class="el" href="classost_1_1_t_c_p_v6_socket.html">TCPV6Socket</a> &server)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a3aed78339f5695c1b281a59473628cb5">TCPStream</a> (const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> &host, <a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port, unsigned mss=536, bool throwflag=true, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> <a class="el" href="classost_1_1_t_c_p_stream.html#ae223ae380e2dc9d2e64cde0a577eccf2">timeout</a>=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a TCP stream by connecting to a TCP socket (on a remote machine). <a href="#a3aed78339f5695c1b281a59473628cb5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a404f9e717f04b2d68fecd61b246b8ead">TCPStream</a> (const <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> &host, <a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port, unsigned mss=536, bool throwflag=true, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> <a class="el" href="classost_1_1_t_c_p_stream.html#ae223ae380e2dc9d2e64cde0a577eccf2">timeout</a>=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a744b09288892788e8b7f0453850d3562">TCPStream</a> (const char *name, <a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">Family</a> <a class="el" href="classost_1_1_t_c_p_stream.html#aecc5f6b34232ba0fef048f53fdaa51fc">family</a>=IPV4, unsigned mss=536, bool throwflag=false, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timer=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a named TCP <a class="el" href="classost_1_1_socket.html" title="The Socket is used as the base for all Internet protocol services under Common C++...">Socket</a> connected to a remote machine. <a href="#a744b09288892788e8b7f0453850d3562"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a1bdf8e7962c57d6086117d5a790ad3f6">setTimeout</a> (<a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the I/O operation timeout for socket I/O operations. <a href="#a1bdf8e7962c57d6086117d5a790ad3f6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a35ce0f9982969a1fe9ab2fa583802945">TCPStream</a> (const <a class="el" href="classost_1_1_t_c_p_stream.html">TCPStream</a> &source)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A copy constructor creates a new stream buffer. <a href="#a35ce0f9982969a1fe9ab2fa583802945"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#aebd30d743538f2c3d95e2b1d214f176b">~TCPStream</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flush and empty all buffers, and then remove the allocated buffers. <a href="#aebd30d743538f2c3d95e2b1d214f176b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a75847ccff483b077c3b7c57b03a5175b">sync</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flushes the stream input and output buffers, writes pending output. <a href="#a75847ccff483b077c3b7c57b03a5175b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#ab418e62f385b62680825beaf79c00df4">printf</a> (const char *format,...)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print content into a socket. <a href="#ab418e62f385b62680825beaf79c00df4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#aeb71ab0a1a1ff92095e5421701649ad2">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> <a class="el" href="classost_1_1_t_c_p_stream.html#ae223ae380e2dc9d2e64cde0a577eccf2">timeout</a>=TIMEOUT_INF)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the status of pending stream data. <a href="#aeb71ab0a1a1ff92095e5421701649ad2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a0150df4f03d32e200b22d0f06404ac39">peek</a> (void *buf, size_t len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Examine contents of next waiting packet. <a href="#a0150df4f03d32e200b22d0f06404ac39"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a0d016d7c968dcfcb0d3e15e759af4c5f">getBufferSize</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the size of the current stream buffering used. <a href="#a0d016d7c968dcfcb0d3e15e759af4c5f"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#ac223dac737c08d1b109bdc06be0b5493">allocate</a> (size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to allocate the buffer space needed for iostream operations. <a href="#ac223dac737c08d1b109bdc06be0b5493"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#ad64fb34a2a8003fac17a471060e89b39">endStream</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to terminate the buffer space and cleanup the socket connection. <a href="#ad64fb34a2a8003fac17a471060e89b39"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a8bba1f2724c35992a48ef7322214a3dc">underflow</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This streambuf method is used to load the input buffer through the established tcp socket connection. <a href="#a8bba1f2724c35992a48ef7322214a3dc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a9c1c5fa96fd3dc099ef452691075e492">uflow</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This streambuf method is used for doing unbuffered reads through the establish tcp socket connection when in interactive mode. <a href="#a9c1c5fa96fd3dc099ef452691075e492"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a5be264ef6d4972f0c213aed20d233bbf">overflow</a> (int ch)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This streambuf method is used to write the output buffer through the established tcp connection. <a href="#a5be264ef6d4972f0c213aed20d233bbf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a39d12c649b784cf83dfbd36581f27d8c">connect</a> (const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> &host, <a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port, unsigned mss=536)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a TCP stream by connecting to a TCP socket (on a remote machine). <a href="#a39d12c649b784cf83dfbd36581f27d8c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#aa2f4de4c7606cc893d16fa28efb7f438">connect</a> (const <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> &host, <a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port, unsigned mss=536)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a17ec811f69da42d9c6f2d5b940dc54e0">connect</a> (const char *name, unsigned mss=536)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connect a TCP stream to a named destination host and port number, using getaddrinfo interface if available. <a href="#a17ec811f69da42d9c6f2d5b940dc54e0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::iostream * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a5191b9c6d7c2369f96f236ae78b25452">tcp</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used in derived classes to refer to the current object via it's iostream. <a href="#a5191b9c6d7c2369f96f236ae78b25452"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#ae223ae380e2dc9d2e64cde0a577eccf2">timeout</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a1eb7fe5844a5c0a5708d658187e9839b">bufsize</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">Family</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#aecc5f6b34232ba0fef048f53fdaa51fc">family</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a6e0d7b50899682ff1997239b85427469">gbuf</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#afe373d1dd6090f4627e2361ff3a4fcdd">pbuf</a></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_t_c_p_stream.html">TCPStream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a203329196708b27f1e703e8c6b274490">crlf</a> (<a class="el" href="classost_1_1_t_c_p_stream.html">TCPStream</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_t_c_p_stream.html">TCPStream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a83209402df6507effb431cca0e8f06cc">lfcr</a> (<a class="el" href="classost_1_1_t_c_p_stream.html">TCPStream</a> &)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>TCP streams are used to represent TCP client connections to a server by TCP protocol servers for accepting client connections. </p>
<p>The TCP stream is a C++ "stream" class, and can accept streaming of data to and from other C++ objects using the << and >> operators.</p>
<p><a class="el" href="classost_1_1_t_c_p_stream.html" title="TCP streams are used to represent TCP client connections to a server by TCP protocol...">TCPStream</a> itself can be formed either by connecting to a bound network address of a TCP server, or can be created when "accepting" a network connection from a TCP server.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> streamable TCP socket connection. </dd></dl>
<dl><dt><b>Examples: </b></dt><dd>
<p><a class="el" href="tcp_8cpp-example.html#_a5">tcp.cpp</a>, and <a class="el" href="tcpstr1_8cpp-example.html#_a3">tcpstr1.cpp</a>.</p>
</dd>
</dl><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa2ee8f719d30376c22ce9503baa9f43c"></a><!-- doxytag: member="ost::TCPStream::TCPStream" ref="aa2ee8f719d30376c22ce9503baa9f43c" args="(Family family=IPV4, bool throwflag=true, timeout_t to=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::TCPStream::TCPStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">Family</a> </td>
<td class="paramname"> <em>family</em> = <code>IPV4</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>throwflag</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>to</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The constructor required for building other classes or to start an unconnected <a class="el" href="classost_1_1_t_c_p_stream.html" title="TCP streams are used to represent TCP client connections to a server by TCP protocol...">TCPStream</a> for connect. </p>
</div>
</div>
<a class="anchor" id="a8e008d40cdf19e3216cce66dfd084991"></a><!-- doxytag: member="ost::TCPStream::TCPStream" ref="a8e008d40cdf19e3216cce66dfd084991" args="(TCPSocket &server, bool throwflag=true, timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::TCPStream::TCPStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_t_c_p_socket.html">TCPSocket</a> & </td>
<td class="paramname"> <em>server</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>throwflag</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timeout</em> = <code>0</code></td><td> </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> </td><td>socket listening </td></tr>
<tr><td valign="top"></td><td valign="top"><em>throwflag</em> </td><td>flag to throw errors. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>for all operations. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a24bea89abbc213b6f60918ee233c6437"></a><!-- doxytag: member="ost::TCPStream::TCPStream" ref="a24bea89abbc213b6f60918ee233c6437" args="(TCPV6Socket &server, bool throwflag=true, timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::TCPStream::TCPStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_t_c_p_v6_socket.html">TCPV6Socket</a> & </td>
<td class="paramname"> <em>server</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>throwflag</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timeout</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a3aed78339f5695c1b281a59473628cb5"></a><!-- doxytag: member="ost::TCPStream::TCPStream" ref="a3aed78339f5695c1b281a59473628cb5" args="(const IPV4Host &host, tpport_t port, unsigned mss=536, bool throwflag=true, timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::TCPStream::TCPStream </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> & </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> </td>
<td class="paramname"> <em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>mss</em> = <code>536</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>throwflag</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timeout</em> = <code>0</code></td><td> </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> </td><td>address of remote TCP server. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>number to connect. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mss</em> </td><td>maximum segment size of streaming buffers. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>throwflag</em> </td><td>flag to throw errors. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>for all operations. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a404f9e717f04b2d68fecd61b246b8ead"></a><!-- doxytag: member="ost::TCPStream::TCPStream" ref="a404f9e717f04b2d68fecd61b246b8ead" args="(const IPV6Host &host, tpport_t port, unsigned mss=536, bool throwflag=true, timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::TCPStream::TCPStream </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> & </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> </td>
<td class="paramname"> <em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>mss</em> = <code>536</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>throwflag</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timeout</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a744b09288892788e8b7f0453850d3562"></a><!-- doxytag: member="ost::TCPStream::TCPStream" ref="a744b09288892788e8b7f0453850d3562" args="(const char *name, Family family=IPV4, unsigned mss=536, bool throwflag=false, timeout_t timer=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::TCPStream::TCPStream </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">Family</a> </td>
<td class="paramname"> <em>family</em> = <code>IPV4</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>mss</em> = <code>536</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>throwflag</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timer</em> = <code>0</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 named TCP <a class="el" href="classost_1_1_socket.html" title="The Socket is used as the base for all Internet protocol services under Common C++...">Socket</a> connected to 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>name</em> </td><td>of remote service. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>family</em> </td><td>of protocol. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mss</em> </td><td>maximum segment size of streaming buffers. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>throwflag</em> </td><td>flag to throw errors. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timer</em> </td><td>for timeout for all operations. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a35ce0f9982969a1fe9ab2fa583802945"></a><!-- doxytag: member="ost::TCPStream::TCPStream" ref="a35ce0f9982969a1fe9ab2fa583802945" args="(const TCPStream &source)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::TCPStream::TCPStream </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_t_c_p_stream.html">TCPStream</a> & </td>
<td class="paramname"> <em>source</em></td>
<td> ) </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> </td><td>reference of stream to copy from. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aebd30d743538f2c3d95e2b1d214f176b"></a><!-- doxytag: member="ost::TCPStream::~TCPStream" ref="aebd30d743538f2c3d95e2b1d214f176b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ost::TCPStream::~TCPStream </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </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="ac223dac737c08d1b109bdc06be0b5493"></a><!-- doxytag: member="ost::TCPStream::allocate" ref="ac223dac737c08d1b109bdc06be0b5493" args="(size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::TCPStream::allocate </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used to allocate the buffer space needed for iostream operations. </p>
<p>This function is called by the constructor.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of stream buffers from constructor. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aba5de9163b215f181a43903099a8c403"></a><!-- doxytag: member="ost::TCPStream::connect" ref="aba5de9163b215f181a43903099a8c403" args="(TCPV6Socket &server)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::TCPStream::connect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_t_c_p_v6_socket.html">TCPV6Socket</a> & </td>
<td class="paramname"> <em>server</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a75ef0dedbc6985ff113817a24cb8fc14"></a><!-- doxytag: member="ost::TCPStream::connect" ref="a75ef0dedbc6985ff113817a24cb8fc14" args="(TCPSocket &server)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::TCPStream::connect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_t_c_p_socket.html">TCPSocket</a> & </td>
<td class="paramname"> <em>server</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Accept a connection from a TCP Server. </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 listening </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a17ec811f69da42d9c6f2d5b940dc54e0"></a><!-- doxytag: member="ost::TCPStream::connect" ref="a17ec811f69da42d9c6f2d5b940dc54e0" args="(const char *name, unsigned mss=536)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::TCPStream::connect </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>mss</em> = <code>536</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Connect a TCP stream to a named destination host and port number, using getaddrinfo interface if available. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of host and service to connect </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mss</em> </td><td>maximum segment size of stream buffer </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa2f4de4c7606cc893d16fa28efb7f438"></a><!-- doxytag: member="ost::TCPStream::connect" ref="aa2f4de4c7606cc893d16fa28efb7f438" args="(const IPV6Host &host, tpport_t port, unsigned mss=536)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::TCPStream::connect </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> & </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> </td>
<td class="paramname"> <em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>mss</em> = <code>536</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a39d12c649b784cf83dfbd36581f27d8c"></a><!-- doxytag: member="ost::TCPStream::connect" ref="a39d12c649b784cf83dfbd36581f27d8c" args="(const IPV4Host &host, tpport_t port, unsigned mss=536)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::TCPStream::connect </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> & </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> </td>
<td class="paramname"> <em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>mss</em> = <code>536</code></td><td> </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> </td><td>address of remote TCP server. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>number to connect. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mss</em> </td><td>maximum segment size of streaming buffers. </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="tcp_8cpp-example.html#a6">tcp.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a465c1772f8b6c1e1effcdfdc248622af"></a><!-- doxytag: member="ost::TCPStream::disconnect" ref="a465c1772f8b6c1e1effcdfdc248622af" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::TCPStream::disconnect </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Disconnect the current session and prepare for a new one. </p>
<p>Reimplemented in <a class="el" href="classost_1_1_s_s_l_stream.html#a005229a64cb18e6c39db5bde8f026eac">ost::SSLStream</a>.</p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="tcp_8cpp-example.html#a10">tcp.cpp</a>, and <a class="el" href="tcpstr1_8cpp-example.html#a4">tcpstr1.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad64fb34a2a8003fac17a471060e89b39"></a><!-- doxytag: member="ost::TCPStream::endStream" ref="ad64fb34a2a8003fac17a471060e89b39" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::TCPStream::endStream </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </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>
<p>Reimplemented in <a class="el" href="classost_1_1_s_s_l_stream.html#aee7eb50ad1e1e9bd9a82e4b1f50a20c3">ost::SSLStream</a>.</p>
</div>
</div>
<a class="anchor" id="a0d016d7c968dcfcb0d3e15e759af4c5f"></a><!-- doxytag: member="ost::TCPStream::getBufferSize" ref="a0d016d7c968dcfcb0d3e15e759af4c5f" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t ost::TCPStream::getBufferSize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the size of the current stream buffering used. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>size of stream buffers. </dd></dl>
</div>
</div>
<a class="anchor" id="a4c5fac74099d34d067b075995f53b60a"></a><!-- doxytag: member="ost::TCPStream::getSegmentSize" ref="a4c5fac74099d34d067b075995f53b60a" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ost::TCPStream::getSegmentSize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get protocol segment size. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="tcp_8cpp-example.html#a7">tcp.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="aeb71ab0a1a1ff92095e5421701649ad2"></a><!-- doxytag: member="ost::TCPStream::isPending" ref="aeb71ab0a1a1ff92095e5421701649ad2" args="(Pending pend, timeout_t timeout=TIMEOUT_INF)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::TCPStream::isPending </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_socket.html#a2cb9ccad21fc2f10c23e45cbb99bc6f8">Pending</a> </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> </td>
<td class="paramname"> <em>timeout</em> = <code>TIMEOUT_INF</code></td><td> </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 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 and if write buffer contains data it is first flushed and then checked. </p>
<p>Reimplemented from <a class="el" href="classost_1_1_socket.html#a8eb84be4b5cc91731c16be4f32f5bf3d">ost::Socket</a>.</p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="tcp_8cpp-example.html#a9">tcp.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5be264ef6d4972f0c213aed20d233bbf"></a><!-- doxytag: member="ost::TCPStream::overflow" ref="a5be264ef6d4972f0c213aed20d233bbf" args="(int ch)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ost::TCPStream::overflow </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>ch</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This streambuf method is used to write the output buffer through the established tcp connection. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ch</em> </td><td>char to push through. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>char pushed through. </dd></dl>
</div>
</div>
<a class="anchor" id="a0150df4f03d32e200b22d0f06404ac39"></a><!-- doxytag: member="ost::TCPStream::peek" ref="a0150df4f03d32e200b22d0f06404ac39" args="(void *buf, size_t len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t ost::TCPStream::peek </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>len</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Examine contents of next waiting packet. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>pointer to packet buffer for contents. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>of packet buffer. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of bytes examined. </dd></dl>
</div>
</div>
<a class="anchor" id="ab418e62f385b62680825beaf79c00df4"></a><!-- doxytag: member="ost::TCPStream::printf" ref="ab418e62f385b62680825beaf79c00df4" args="(const char *format,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t ost::TCPStream::printf </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"> <em>...</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Print content into a socket. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>count of bytes sent. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>string </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1bdf8e7962c57d6086117d5a790ad3f6"></a><!-- doxytag: member="ost::TCPStream::setTimeout" ref="a1bdf8e7962c57d6086117d5a790ad3f6" args="(timeout_t timer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::TCPStream::setTimeout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timer</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the I/O operation timeout for socket I/O operations. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>timer</em> </td><td>to change timeout. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classost_1_1_u_r_l_stream.html#a82863fbf49c6095877c2147a670e3e71">ost::URLStream</a>.</p>
</div>
</div>
<a class="anchor" id="a75847ccff483b077c3b7c57b03a5175b"></a><!-- doxytag: member="ost::TCPStream::sync" ref="a75847ccff483b077c3b7c57b03a5175b" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ost::TCPStream::sync </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Flushes the stream input and output buffers, writes pending output. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success. </dd></dl>
</div>
</div>
<a class="anchor" id="a5191b9c6d7c2369f96f236ae78b25452"></a><!-- doxytag: member="ost::TCPStream::tcp" ref="a5191b9c6d7c2369f96f236ae78b25452" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::iostream* ost::TCPStream::tcp </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used in derived classes to refer to the current object via it's iostream. </p>
<p>For example, to send a set of characters in a derived method, one might use *tcp() << "test".</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>stream pointer of this object. </dd></dl>
</div>
</div>
<a class="anchor" id="a9c1c5fa96fd3dc099ef452691075e492"></a><!-- doxytag: member="ost::TCPStream::uflow" ref="a9c1c5fa96fd3dc099ef452691075e492" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ost::TCPStream::uflow </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This streambuf method is used for doing unbuffered reads through the establish tcp socket connection when in interactive mode. </p>
<p>Also this method will handle proper use of buffers if not in interative mode.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>char from tcp socket connection, EOF if not connected. </dd></dl>
</div>
</div>
<a class="anchor" id="a8bba1f2724c35992a48ef7322214a3dc"></a><!-- doxytag: member="ost::TCPStream::underflow" ref="a8bba1f2724c35992a48ef7322214a3dc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ost::TCPStream::underflow </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This streambuf method is used to load the input buffer through the established tcp socket connection. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>char from get buffer, EOF if not connected. </dd></dl>
<p>Reimplemented in <a class="el" href="classost_1_1_u_r_l_stream.html#a0dc12a6f57c7ba5d05988dcc12fd41cf">ost::URLStream</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a203329196708b27f1e703e8c6b274490"></a><!-- doxytag: member="ost::TCPStream::crlf" ref="a203329196708b27f1e703e8c6b274490" args="(TCPStream &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_t_c_p_stream.html">TCPStream</a>& crlf </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_t_c_p_stream.html">TCPStream</a> & </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a83209402df6507effb431cca0e8f06cc"></a><!-- doxytag: member="ost::TCPStream::lfcr" ref="a83209402df6507effb431cca0e8f06cc" args="(TCPStream &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_t_c_p_stream.html">TCPStream</a>& lfcr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_t_c_p_stream.html">TCPStream</a> & </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a1eb7fe5844a5c0a5708d658187e9839b"></a><!-- doxytag: member="ost::TCPStream::bufsize" ref="a1eb7fe5844a5c0a5708d658187e9839b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classost_1_1_t_c_p_stream.html#a1eb7fe5844a5c0a5708d658187e9839b">ost::TCPStream::bufsize</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aecc5f6b34232ba0fef048f53fdaa51fc"></a><!-- doxytag: member="ost::TCPStream::family" ref="aecc5f6b34232ba0fef048f53fdaa51fc" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">Family</a> <a class="el" href="classost_1_1_t_c_p_stream.html#aecc5f6b34232ba0fef048f53fdaa51fc">ost::TCPStream::family</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a6e0d7b50899682ff1997239b85427469"></a><!-- doxytag: member="ost::TCPStream::gbuf" ref="a6e0d7b50899682ff1997239b85427469" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="classost_1_1_t_c_p_stream.html#a6e0d7b50899682ff1997239b85427469">ost::TCPStream::gbuf</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="afe373d1dd6090f4627e2361ff3a4fcdd"></a><!-- doxytag: member="ost::TCPStream::pbuf" ref="afe373d1dd6090f4627e2361ff3a4fcdd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * <a class="el" href="classost_1_1_t_c_p_stream.html#afe373d1dd6090f4627e2361ff3a4fcdd">ost::TCPStream::pbuf</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae223ae380e2dc9d2e64cde0a577eccf2"></a><!-- doxytag: member="ost::TCPStream::timeout" ref="ae223ae380e2dc9d2e64cde0a577eccf2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> <a class="el" href="classost_1_1_t_c_p_stream.html#ae223ae380e2dc9d2e64cde0a577eccf2">ost::TCPStream::timeout</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</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
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
ed376d6842ea322c25405e7c23b3bc12
>
files
>
377
