<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GNU CommonC++: ost::TCPStream Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<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 id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_t_c_p_stream.html">TCPStream</a></div>
<h1>ost::TCPStream Class Reference</h1><!-- doxytag: class="ost::TCPStream" --><!-- doxytag: inherits="ost::Socket" -->TCP streams are used to represent TCP client connections to a server by TCP protocol servers for accepting client connections.streamable TCP socket connection.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="socket_8h-source.html">socket.h</a>></code>
<p>
<p>Inheritance diagram for ost::TCPStream:
<p><center><img src="classost_1_1_t_c_p_stream.png" usemap="#ost::TCPStream_map" border="0" alt=""></center>
<map name="ost::TCPStream_map">
<area href="classost_1_1_socket.html" alt="ost::Socket" shape="rect" coords="56,0,158,24">
<area href="classost_1_1_t_c_p_session.html" alt="ost::TCPSession" shape="rect" coords="0,112,102,136">
<area href="classost_1_1_u_r_l_stream.html" alt="ost::URLStream" shape="rect" coords="112,112,214,136">
</map>
<a href="classost_1_1_t_c_p_stream-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a2ee8f719d30376c22ce9503baa9f43c">TCPStream</a> (<a class="el" href="classost_1_1_socket.html#aa032e41b920b38a79c875b8ae375799">Family</a> <a class="el" href="classost_1_1_t_c_p_stream.html#ecc5f6b34232ba0fef048f53fdaa51fc">family</a>=IPV4, bool throwflag=true, <a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">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">TCPStream</a> for connect. <a href="#a2ee8f719d30376c22ce9503baa9f43c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#465c1772f8b6c1e1effcdfdc248622af">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="#465c1772f8b6c1e1effcdfdc248622af"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#4c5fac74099d34d067b075995f53b60a">getSegmentSize</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get protocol segment size. <a href="#4c5fac74099d34d067b075995f53b60a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#8e008d40cdf19e3216cce66dfd084991">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#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> <a class="el" href="classost_1_1_t_c_p_stream.html#e223ae380e2dc9d2e64cde0a577eccf2">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="#8e008d40cdf19e3216cce66dfd084991"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#24bea89abbc213b6f60918ee233c6437">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#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> <a class="el" href="classost_1_1_t_c_p_stream.html#e223ae380e2dc9d2e64cde0a577eccf2">timeout</a>=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#75ef0dedbc6985ff113817a24cb8fc14">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="#75ef0dedbc6985ff113817a24cb8fc14"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#ba5de9163b215f181a43903099a8c403">connect</a> (<a class="el" href="classost_1_1_t_c_p_v6_socket.html">TCPV6Socket</a> &server)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#3aed78339f5695c1b281a59473628cb5">TCPStream</a> (const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> &host, <a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port, unsigned mss=536, bool throwflag=true, <a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> <a class="el" href="classost_1_1_t_c_p_stream.html#e223ae380e2dc9d2e64cde0a577eccf2">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="#3aed78339f5695c1b281a59473628cb5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#404f9e717f04b2d68fecd61b246b8ead">TCPStream</a> (const <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> &host, <a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port, unsigned mss=536, bool throwflag=true, <a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> <a class="el" href="classost_1_1_t_c_p_stream.html#e223ae380e2dc9d2e64cde0a577eccf2">timeout</a>=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#744b09288892788e8b7f0453850d3562">TCPStream</a> (const char *name, <a class="el" href="classost_1_1_socket.html#aa032e41b920b38a79c875b8ae375799">Family</a> <a class="el" href="classost_1_1_t_c_p_stream.html#ecc5f6b34232ba0fef048f53fdaa51fc">family</a>=IPV4, unsigned mss=536, bool throwflag=false, <a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">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">Socket</a> connected to a remote machine. <a href="#744b09288892788e8b7f0453850d3562"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#1bdf8e7962c57d6086117d5a790ad3f6">setTimeout</a> (<a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">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="#1bdf8e7962c57d6086117d5a790ad3f6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#35ce0f9982969a1fe9ab2fa583802945">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="#35ce0f9982969a1fe9ab2fa583802945"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#ebd30d743538f2c3d95e2b1d214f176b">~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="#ebd30d743538f2c3d95e2b1d214f176b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#75847ccff483b077c3b7c57b03a5175b">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="#75847ccff483b077c3b7c57b03a5175b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#b418e62f385b62680825beaf79c00df4">printf</a> (const char *format,...)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print content into a socket. <a href="#b418e62f385b62680825beaf79c00df4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#eb71ab0a1a1ff92095e5421701649ad2">isPending</a> (<a class="el" href="classost_1_1_socket.html#c2fe3b8bf4dfc66c7df11dfa1ce4415c">Pending</a> pend, <a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> <a class="el" href="classost_1_1_t_c_p_stream.html#e223ae380e2dc9d2e64cde0a577eccf2">timeout</a>=TIMEOUT_INF)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the status of pending stream data. <a href="#eb71ab0a1a1ff92095e5421701649ad2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#0150df4f03d32e200b22d0f06404ac39">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="#0150df4f03d32e200b22d0f06404ac39"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#0d016d7c968dcfcb0d3e15e759af4c5f">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="#0d016d7c968dcfcb0d3e15e759af4c5f"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#c223dac737c08d1b109bdc06be0b5493">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="#c223dac737c08d1b109bdc06be0b5493"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#d64fb34a2a8003fac17a471060e89b39">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="#d64fb34a2a8003fac17a471060e89b39"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#8bba1f2724c35992a48ef7322214a3dc">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="#8bba1f2724c35992a48ef7322214a3dc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#9c1c5fa96fd3dc099ef452691075e492">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="#9c1c5fa96fd3dc099ef452691075e492"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#5be264ef6d4972f0c213aed20d233bbf">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="#5be264ef6d4972f0c213aed20d233bbf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#39d12c649b784cf83dfbd36581f27d8c">connect</a> (const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> &host, <a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">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="#39d12c649b784cf83dfbd36581f27d8c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#a2f4de4c7606cc893d16fa28efb7f438">connect</a> (const <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> &host, <a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port, unsigned mss=536)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#17ec811f69da42d9c6f2d5b940dc54e0">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="#17ec811f69da42d9c6f2d5b940dc54e0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::iostream * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#5191b9c6d7c2369f96f236ae78b25452">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="#5191b9c6d7c2369f96f236ae78b25452"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#e223ae380e2dc9d2e64cde0a577eccf2">timeout</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#1eb7fe5844a5c0a5708d658187e9839b">bufsize</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_socket.html#aa032e41b920b38a79c875b8ae375799">Family</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#ecc5f6b34232ba0fef048f53fdaa51fc">family</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#6e0d7b50899682ff1997239b85427469">gbuf</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_c_p_stream.html#fe373d1dd6090f4627e2361ff3a4fcdd">pbuf</a></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap 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#203329196708b27f1e703e8c6b274490">crlf</a> (<a class="el" href="classost_1_1_t_c_p_stream.html">TCPStream</a> &)</td></tr>
<tr><td class="memItemLeft" nowrap 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#83209402df6507effb431cca0e8f06cc">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>
TCP streams are used to represent TCP client connections to a server by TCP protocol servers for accepting client connections.streamable TCP socket connection.
<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>
<a class="el" href="classost_1_1_t_c_p_stream.html">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 compact><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<p>
<a class="el" href="tcp_8cpp-example.html#_a39">tcp.cpp</a>, and <a class="el" href="tcpstr1_8cpp-example.html#_a68">tcpstr1.cpp</a>.</dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a2ee8f719d30376c22ce9503baa9f43c"></a><!-- doxytag: member="ost::TCPStream::TCPStream" ref="a2ee8f719d30376c22ce9503baa9f43c" args="(Family family=IPV4, bool throwflag=true, timeout_t to=0)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::TCPStream::TCPStream </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_socket.html#aa032e41b920b38a79c875b8ae375799">Family</a> </td>
<td class="mdname" nowrap> <em>family</em> = <code>IPV4</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>throwflag</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="mdname" nowrap> <em>to</em> = <code>0</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<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">TCPStream</a> for connect.
<p>
</td>
</tr>
</table>
<a class="anchor" name="8e008d40cdf19e3216cce66dfd084991"></a><!-- doxytag: member="ost::TCPStream::TCPStream" ref="8e008d40cdf19e3216cce66dfd084991" args="(TCPSocket &server, bool throwflag=true, timeout_t timeout=0)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::TCPStream::TCPStream </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_t_c_p_socket.html">TCPSocket</a> & </td>
<td class="mdname" nowrap> <em>server</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>throwflag</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="mdname" nowrap> <em>timeout</em> = <code>0</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create a TCP stream by accepting a connection from a bound TCP socket acting as a server.
<p>
This performs an "accept" call.<p>
<dl compact><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>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="24bea89abbc213b6f60918ee233c6437"></a><!-- doxytag: member="ost::TCPStream::TCPStream" ref="24bea89abbc213b6f60918ee233c6437" args="(TCPV6Socket &server, bool throwflag=true, timeout_t timeout=0)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::TCPStream::TCPStream </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_t_c_p_v6_socket.html">TCPV6Socket</a> & </td>
<td class="mdname" nowrap> <em>server</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>throwflag</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="mdname" nowrap> <em>timeout</em> = <code>0</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="3aed78339f5695c1b281a59473628cb5"></a><!-- doxytag: member="ost::TCPStream::TCPStream" ref="3aed78339f5695c1b281a59473628cb5" args="(const IPV4Host &host, tpport_t port, unsigned mss=536, bool throwflag=true, timeout_t timeout=0)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::TCPStream::TCPStream </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> & </td>
<td class="mdname" nowrap> <em>host</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="mdname" nowrap> <em>port</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned </td>
<td class="mdname" nowrap> <em>mss</em> = <code>536</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>throwflag</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="mdname" nowrap> <em>timeout</em> = <code>0</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create a TCP stream by connecting to a TCP socket (on a remote machine).
<p>
<dl compact><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>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="404f9e717f04b2d68fecd61b246b8ead"></a><!-- doxytag: member="ost::TCPStream::TCPStream" ref="404f9e717f04b2d68fecd61b246b8ead" args="(const IPV6Host &host, tpport_t port, unsigned mss=536, bool throwflag=true, timeout_t timeout=0)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::TCPStream::TCPStream </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> & </td>
<td class="mdname" nowrap> <em>host</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="mdname" nowrap> <em>port</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned </td>
<td class="mdname" nowrap> <em>mss</em> = <code>536</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>throwflag</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="mdname" nowrap> <em>timeout</em> = <code>0</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="744b09288892788e8b7f0453850d3562"></a><!-- doxytag: member="ost::TCPStream::TCPStream" ref="744b09288892788e8b7f0453850d3562" args="(const char *name, Family family=IPV4, unsigned mss=536, bool throwflag=false, timeout_t timer=0)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::TCPStream::TCPStream </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>name</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="classost_1_1_socket.html#aa032e41b920b38a79c875b8ae375799">Family</a> </td>
<td class="mdname" nowrap> <em>family</em> = <code>IPV4</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned </td>
<td class="mdname" nowrap> <em>mss</em> = <code>536</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>throwflag</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="mdname" nowrap> <em>timer</em> = <code>0</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Construct a named TCP <a class="el" href="classost_1_1_socket.html">Socket</a> connected to a remote machine.
<p>
<dl compact><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>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="35ce0f9982969a1fe9ab2fa583802945"></a><!-- doxytag: member="ost::TCPStream::TCPStream" ref="35ce0f9982969a1fe9ab2fa583802945" args="(const TCPStream &source)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::TCPStream::TCPStream </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_t_c_p_stream.html">TCPStream</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>source</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
A copy constructor creates a new stream buffer.
<p>
<dl compact><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>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="ebd30d743538f2c3d95e2b1d214f176b"></a><!-- doxytag: member="ost::TCPStream::~TCPStream" ref="ebd30d743538f2c3d95e2b1d214f176b" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ost::TCPStream::~TCPStream </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Flush and empty all buffers, and then remove the allocated buffers.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c223dac737c08d1b109bdc06be0b5493"></a><!-- doxytag: member="ost::TCPStream::allocate" ref="c223dac737c08d1b109bdc06be0b5493" args="(size_t size)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::TCPStream::allocate </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">size_t </td>
<td class="mdname1" valign="top" nowrap> <em>size</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Used to allocate the buffer space needed for iostream operations.
<p>
This function is called by the constructor.<p>
<dl compact><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>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="ba5de9163b215f181a43903099a8c403"></a><!-- doxytag: member="ost::TCPStream::connect" ref="ba5de9163b215f181a43903099a8c403" args="(TCPV6Socket &server)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::TCPStream::connect </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_t_c_p_v6_socket.html">TCPV6Socket</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>server</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="75ef0dedbc6985ff113817a24cb8fc14"></a><!-- doxytag: member="ost::TCPStream::connect" ref="75ef0dedbc6985ff113817a24cb8fc14" args="(TCPSocket &server)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::TCPStream::connect </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_t_c_p_socket.html">TCPSocket</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>server</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Accept a connection from a TCP Server.
<p>
<dl compact><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>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="17ec811f69da42d9c6f2d5b940dc54e0"></a><!-- doxytag: member="ost::TCPStream::connect" ref="17ec811f69da42d9c6f2d5b940dc54e0" args="(const char *name, unsigned mss=536)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::TCPStream::connect </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>name</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned </td>
<td class="mdname" nowrap> <em>mss</em> = <code>536</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Connect a TCP stream to a named destination host and port number, using getaddrinfo interface if available.
<p>
<dl compact><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>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a2f4de4c7606cc893d16fa28efb7f438"></a><!-- doxytag: member="ost::TCPStream::connect" ref="a2f4de4c7606cc893d16fa28efb7f438" args="(const IPV6Host &host, tpport_t port, unsigned mss=536)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::TCPStream::connect </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> & </td>
<td class="mdname" nowrap> <em>host</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="mdname" nowrap> <em>port</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned </td>
<td class="mdname" nowrap> <em>mss</em> = <code>536</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="39d12c649b784cf83dfbd36581f27d8c"></a><!-- doxytag: member="ost::TCPStream::connect" ref="39d12c649b784cf83dfbd36581f27d8c" args="(const IPV4Host &host, tpport_t port, unsigned mss=536)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::TCPStream::connect </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> & </td>
<td class="mdname" nowrap> <em>host</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="mdname" nowrap> <em>port</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned </td>
<td class="mdname" nowrap> <em>mss</em> = <code>536</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create a TCP stream by connecting to a TCP socket (on a remote machine).
<p>
<dl compact><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>
</dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="tcp_8cpp-example.html#a40">tcp.cpp</a>.</dl> </td>
</tr>
</table>
<a class="anchor" name="465c1772f8b6c1e1effcdfdc248622af"></a><!-- doxytag: member="ost::TCPStream::disconnect" ref="465c1772f8b6c1e1effcdfdc248622af" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::TCPStream::disconnect </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Disconnect the current session and prepare for a new one.
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="tcp_8cpp-example.html#a44">tcp.cpp</a>, and <a class="el" href="tcpstr1_8cpp-example.html#a69">tcpstr1.cpp</a>.</dl> </td>
</tr>
</table>
<a class="anchor" name="d64fb34a2a8003fac17a471060e89b39"></a><!-- doxytag: member="ost::TCPStream::endStream" ref="d64fb34a2a8003fac17a471060e89b39" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::TCPStream::endStream </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Used to terminate the buffer space and cleanup the socket connection.
<p>
This fucntion is called by the destructor. </td>
</tr>
</table>
<a class="anchor" name="0d016d7c968dcfcb0d3e15e759af4c5f"></a><!-- doxytag: member="ost::TCPStream::getBufferSize" ref="0d016d7c968dcfcb0d3e15e759af4c5f" args="(void) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">size_t ost::TCPStream::getBufferSize </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return the size of the current stream buffering used.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>size of stream buffers. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="4c5fac74099d34d067b075995f53b60a"></a><!-- doxytag: member="ost::TCPStream::getSegmentSize" ref="4c5fac74099d34d067b075995f53b60a" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int ost::TCPStream::getSegmentSize </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get protocol segment size.
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="tcp_8cpp-example.html#a41">tcp.cpp</a>.</dl> </td>
</tr>
</table>
<a class="anchor" name="eb71ab0a1a1ff92095e5421701649ad2"></a><!-- doxytag: member="ost::TCPStream::isPending" ref="eb71ab0a1a1ff92095e5421701649ad2" args="(Pending pend, timeout_t timeout=TIMEOUT_INF)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool ost::TCPStream::isPending </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_socket.html#c2fe3b8bf4dfc66c7df11dfa1ce4415c">Pending</a> </td>
<td class="mdname" nowrap> <em>pend</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="mdname" nowrap> <em>timeout</em> = <code>TIMEOUT_INF</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the status of pending stream data.
<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. <dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="tcp_8cpp-example.html#a43">tcp.cpp</a>.</dl> </td>
</tr>
</table>
<a class="anchor" name="5be264ef6d4972f0c213aed20d233bbf"></a><!-- doxytag: member="ost::TCPStream::overflow" ref="5be264ef6d4972f0c213aed20d233bbf" args="(int ch)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int ost::TCPStream::overflow </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>ch</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This streambuf method is used to write the output buffer through the established tcp connection.
<p>
<dl compact><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>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>char pushed through. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="0150df4f03d32e200b22d0f06404ac39"></a><!-- doxytag: member="ost::TCPStream::peek" ref="0150df4f03d32e200b22d0f06404ac39" args="(void *buf, size_t len)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ssize_t ost::TCPStream::peek </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void * </td>
<td class="mdname" nowrap> <em>buf</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>size_t </td>
<td class="mdname" nowrap> <em>len</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Examine contents of next waiting packet.
<p>
<dl compact><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>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>number of bytes examined. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="b418e62f385b62680825beaf79c00df4"></a><!-- doxytag: member="ost::TCPStream::printf" ref="b418e62f385b62680825beaf79c00df4" args="(const char *format,...)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">size_t ost::TCPStream::printf </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>format</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap> </td>
<td class="mdname" nowrap> <em>...</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Print content into a socket.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>count of bytes sent. </dd></dl>
<dl compact><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>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="1bdf8e7962c57d6086117d5a790ad3f6"></a><!-- doxytag: member="ost::TCPStream::setTimeout" ref="1bdf8e7962c57d6086117d5a790ad3f6" args="(timeout_t timer)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::TCPStream::setTimeout </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="mdname1" valign="top" nowrap> <em>timer</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the I/O operation timeout for socket I/O operations.
<p>
<dl compact><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>
</dl>
<p>
Reimplemented in <a class="el" href="classost_1_1_u_r_l_stream.html#82863fbf49c6095877c2147a670e3e71">ost::URLStream</a>. </td>
</tr>
</table>
<a class="anchor" name="75847ccff483b077c3b7c57b03a5175b"></a><!-- doxytag: member="ost::TCPStream::sync" ref="75847ccff483b077c3b7c57b03a5175b" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int ost::TCPStream::sync </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Flushes the stream input and output buffers, writes pending output.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>0 on success. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="5191b9c6d7c2369f96f236ae78b25452"></a><!-- doxytag: member="ost::TCPStream::tcp" ref="5191b9c6d7c2369f96f236ae78b25452" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">std::iostream* ost::TCPStream::tcp </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Used in derived classes to refer to the current object via it's iostream.
<p>
For example, to send a set of characters in a derived method, one might use *tcp() << "test".<p>
<dl compact><dt><b>Returns:</b></dt><dd>stream pointer of this object. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="9c1c5fa96fd3dc099ef452691075e492"></a><!-- doxytag: member="ost::TCPStream::uflow" ref="9c1c5fa96fd3dc099ef452691075e492" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int ost::TCPStream::uflow </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This streambuf method is used for doing unbuffered reads through the establish tcp socket connection when in interactive mode.
<p>
Also this method will handle proper use of buffers if not in interative mode.<p>
<dl compact><dt><b>Returns:</b></dt><dd>char from tcp socket connection, EOF if not connected. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="8bba1f2724c35992a48ef7322214a3dc"></a><!-- doxytag: member="ost::TCPStream::underflow" ref="8bba1f2724c35992a48ef7322214a3dc" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int ost::TCPStream::underflow </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This streambuf method is used to load the input buffer through the established tcp socket connection.
<p>
<dl compact><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#0dc12a6f57c7ba5d05988dcc12fd41cf">ost::URLStream</a>. </td>
</tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="203329196708b27f1e703e8c6b274490"></a><!-- doxytag: member="ost::TCPStream::crlf" ref="203329196708b27f1e703e8c6b274490" args="(TCPStream &)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_t_c_p_stream.html">TCPStream</a>& crlf </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_t_c_p_stream.html">TCPStream</a> & </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [friend]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="83209402df6507effb431cca0e8f06cc"></a><!-- doxytag: member="ost::TCPStream::lfcr" ref="83209402df6507effb431cca0e8f06cc" args="(TCPStream &)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_t_c_p_stream.html">TCPStream</a>& lfcr </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_t_c_p_stream.html">TCPStream</a> & </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [friend]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="1eb7fe5844a5c0a5708d658187e9839b"></a><!-- doxytag: member="ost::TCPStream::bufsize" ref="1eb7fe5844a5c0a5708d658187e9839b" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">size_t <a class="el" href="classost_1_1_t_c_p_stream.html#1eb7fe5844a5c0a5708d658187e9839b">ost::TCPStream::bufsize</a><code> [protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="ecc5f6b34232ba0fef048f53fdaa51fc"></a><!-- doxytag: member="ost::TCPStream::family" ref="ecc5f6b34232ba0fef048f53fdaa51fc" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_socket.html#aa032e41b920b38a79c875b8ae375799">Family</a> <a class="el" href="classost_1_1_t_c_p_stream.html#ecc5f6b34232ba0fef048f53fdaa51fc">ost::TCPStream::family</a><code> [protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="6e0d7b50899682ff1997239b85427469"></a><!-- doxytag: member="ost::TCPStream::gbuf" ref="6e0d7b50899682ff1997239b85427469" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">char* <a class="el" href="classost_1_1_t_c_p_stream.html#6e0d7b50899682ff1997239b85427469">ost::TCPStream::gbuf</a><code> [protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="fe373d1dd6090f4627e2361ff3a4fcdd"></a><!-- doxytag: member="ost::TCPStream::pbuf" ref="fe373d1dd6090f4627e2361ff3a4fcdd" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">char * <a class="el" href="classost_1_1_t_c_p_stream.html#fe373d1dd6090f4627e2361ff3a4fcdd">ost::TCPStream::pbuf</a><code> [protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="e223ae380e2dc9d2e64cde0a577eccf2"></a><!-- doxytag: member="ost::TCPStream::timeout" ref="e223ae380e2dc9d2e64cde0a577eccf2" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> <a class="el" href="classost_1_1_t_c_p_stream.html#e223ae380e2dc9d2e64cde0a577eccf2">ost::TCPStream::timeout</a><code> [protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<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></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:57 2006 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
