<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>ucommon: ucommon::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="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00208.html">ucommon</a>::<a class="el" href="a00153.html">tcpstream</a>
</div>
</div>
<div class="contents">
<h1>ucommon::tcpstream Class Reference</h1><!-- doxytag: class="ucommon::tcpstream" --><!-- doxytag: inherits="ucommon::StreamProtocol" -->
<p>Streamable tcp connection between client and server.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00200_source.html">stream.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucommon::tcpstream:</div>
<div class="dynsection">
<div class="center"><img src="a00549.png" border="0" usemap="#ucommon_1_1tcpstream_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1tcpstream_inherit__map" id="ucommon_1_1tcpstream_inherit__map">
<area shape="rect" id="node7" href="a00144.html" title="Secure socket using std::iostream." alt="" coords="56,229,237,256"/><area shape="rect" id="node2" href="a00147.html" title="Common stream protocol for std C++ i/o classes." alt="" coords="21,80,272,107"/><area shape="rect" id="node4" href="a00030.html" title="Common character processing protocol." alt="" coords="5,5,288,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucommon::tcpstream:</div>
<div class="dynsection">
<div class="center"><img src="a00550.png" border="0" usemap="#ucommon_1_1tcpstream_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1tcpstream_coll__map" id="ucommon_1_1tcpstream_coll__map">
<area shape="rect" id="node2" href="a00147.html" title="Common stream protocol for std C++ i/o classes." alt="" coords="21,80,272,107"/><area shape="rect" id="node4" href="a00030.html" title="Common character processing protocol." alt="" coords="5,5,288,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#a6b2215f96777d0ef4a8dd2eb9fcff3b3">close</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close an active stream connection. <a href="#a6b2215f96777d0ef4a8dd2eb9fcff3b3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#a4e8dcb9d1d6ad4ffc438374e0079e9d7">open</a> (char *host, char *service, unsigned segment=536)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a stream connectoion to a host and service. <a href="#a4e8dcb9d1d6ad4ffc438374e0079e9d7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#a4805aae65525903d64f2e5aca7f373a2">open</a> (<a class="el" href="a00141.html">Socket::address</a> &address, unsigned segment=536)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a stream connection to a tcp service. <a href="#a4805aae65525903d64f2e5aca7f373a2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#a51871b99cf5f7373b01d0b94ae7c215a">operator bool</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">See if stream connection is active. <a href="#a51871b99cf5f7373b01d0b94ae7c215a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#a3cae3a1ce5647f6b06fecef4b7472fba">operator!</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">See if stream is disconnected. <a href="#a3cae3a1ce5647f6b06fecef4b7472fba"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#aece57198908257363ddffe16ae08ea5f">tcpstream</a> (<a class="el" href="a00141.html">Socket::address</a> &address, unsigned segsize=536, <a class="el" href="a00194.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A convenience constructor that creates a connected tcp stream directly from an address. <a href="#aece57198908257363ddffe16ae08ea5f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#a09254be7a5f282aaeddea853fde3e73c">tcpstream</a> (int family=2, <a class="el" href="a00194.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an unconnected tcp stream object that is idle until opened. <a href="#a09254be7a5f282aaeddea853fde3e73c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#a9873845e719ebbf1c87ea49498412b32">tcpstream</a> (<a class="el" href="a00152.html">TCPServer</a> *server, unsigned segsize=536, <a class="el" href="a00194.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a stream from an existing tcp listener. <a href="#a9873845e719ebbf1c87ea49498412b32"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#a2fe84ee70715d6bd8badcb1288b91d2f">tcpstream</a> (<a class="el" href="a00153.html">tcpstream</a> &copy)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#a2fe84ee70715d6bd8badcb1288b91d2f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6457c24098d531676ac33838f27b7bcc"></a><!-- doxytag: member="ucommon::tcpstream::~tcpstream" ref="a6457c24098d531676ac33838f27b7bcc" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#a6457c24098d531676ac33838f27b7bcc">~tcpstream</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a tcp stream. <br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#a7856b5f2aef36e4091906a2ca8fcf6bf">_getch</a> (void)</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="#a7856b5f2aef36e4091906a2ca8fcf6bf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#a982003abba4158fd4660b6153cf3ae49">_putch</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="#a982003abba4158fd4660b6153cf3ae49"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad1d875c707e0eb07c0c0c8735346a137"></a><!-- doxytag: member="ucommon::tcpstream::_read" ref="ad1d875c707e0eb07c0c0c8735346a137" args="(char *buffer, size_t size)" -->
virtual ssize_t </td><td class="memItemRight" valign="bottom"><b>_read</b> (char *buffer, size_t size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3af4c776058420fa671a0042a0cfb1d9"></a><!-- doxytag: member="ucommon::tcpstream::_wait" ref="a3af4c776058420fa671a0042a0cfb1d9" args="(void)" -->
virtual bool </td><td class="memItemRight" valign="bottom"><b>_wait</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0bea12a2294f35dae2012b5882f8040f"></a><!-- doxytag: member="ucommon::tcpstream::_write" ref="a0bea12a2294f35dae2012b5882f8040f" args="(char *buffer, size_t size)" -->
virtual ssize_t </td><td class="memItemRight" valign="bottom"><b>_write</b> (char *buffer, size_t size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae0e921af5aa06066e4da289a06b0a94c"></a><!-- doxytag: member="ucommon::tcpstream::getsocket" ref="ae0e921af5aa06066e4da289a06b0a94c" args="(void)" -->
socket_t </td><td class="memItemRight" valign="bottom"><b>getsocket</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8727c4b68d62978b61daca40ea872db6"></a><!-- doxytag: member="ucommon::tcpstream::release" ref="a8727c4b68d62978b61daca40ea872db6" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#a8727c4b68d62978b61daca40ea872db6">release</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release the tcp stream and destroy the underlying socket. <br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2295d2955764644c133a7f76b0f20702"></a><!-- doxytag: member="ucommon::tcpstream::so" ref="a2295d2955764644c133a7f76b0f20702" args="" -->
socket_t </td><td class="memItemRight" valign="bottom"><b>so</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6f66f50cb3b2f20b84bdf9ffb7ac48c6"></a><!-- doxytag: member="ucommon::tcpstream::timeout" ref="a6f66f50cb3b2f20b84bdf9ffb7ac48c6" args="" -->
<a class="el" href="a00194.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td><td class="memItemRight" valign="bottom"><b>timeout</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Streamable tcp connection between client and server. </p>
<p>The tcp stream class can represent a client connection to a server or an instance of a service generated by a tcp listener. As a stream class, data can be manipulated using the << and >> operators.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00200_source.html#l00109">109</a> of file <a class="el" href="a00200_source.html">stream.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a2fe84ee70715d6bd8badcb1288b91d2f"></a><!-- doxytag: member="ucommon::tcpstream::tcpstream" ref="a2fe84ee70715d6bd8badcb1288b91d2f" args="(tcpstream &copy)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::tcpstream::tcpstream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00153.html">tcpstream</a> & </td>
<td class="paramname"> <em>copy</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy constructor. </p>
<p>.. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>copy</em> </td><td>for object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9873845e719ebbf1c87ea49498412b32"></a><!-- doxytag: member="ucommon::tcpstream::tcpstream" ref="a9873845e719ebbf1c87ea49498412b32" args="(TCPServer *server, unsigned segsize=536, timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::tcpstream::tcpstream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00152.html">TCPServer</a> * </td>
<td class="paramname"> <em>server</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>segsize</em> = <code>536</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00194.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 stream from an existing tcp listener. </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>to accept connection from. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>segsize</em> </td><td>for tcp segments and buffering. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>for socket i/o operations. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a09254be7a5f282aaeddea853fde3e73c"></a><!-- doxytag: member="ucommon::tcpstream::tcpstream" ref="a09254be7a5f282aaeddea853fde3e73c" args="(int family=2, timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::tcpstream::tcpstream </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>family</em> = <code>2</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00194.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 an unconnected tcp stream object that is idle until opened. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>family</em> </td><td>of protocol to create. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>for socket i/o operations. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aece57198908257363ddffe16ae08ea5f"></a><!-- doxytag: member="ucommon::tcpstream::tcpstream" ref="aece57198908257363ddffe16ae08ea5f" args="(Socket::address &address, unsigned segsize=536, timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::tcpstream::tcpstream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00141.html">Socket::address</a> & </td>
<td class="paramname"> <em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>segsize</em> = <code>536</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00194.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>A convenience constructor that creates a connected tcp stream directly from an address. </p>
<p>The socket is constructed to match the type of the the address family in the socket address that is passed. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>address</em> </td><td>of service to connect to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>segsize</em> </td><td>for tcp segments and buffering. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>for socket i/o operations. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7856b5f2aef36e4091906a2ca8fcf6bf"></a><!-- doxytag: member="ucommon::tcpstream::_getch" ref="a7856b5f2aef36e4091906a2ca8fcf6bf" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ucommon::tcpstream::_getch </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>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>Implements <a class="el" href="a00030.html#af4c7630fd8ed62d09bb5df069c264a06">ucommon::CharacterProtocol</a>.</p>
</div>
</div>
<a class="anchor" id="a982003abba4158fd4660b6153cf3ae49"></a><!-- doxytag: member="ucommon::tcpstream::_putch" ref="a982003abba4158fd4660b6153cf3ae49" args="(int ch)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ucommon::tcpstream::_putch </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>ch</em></td>
<td> ) </td>
<td><code> [protected, virtual]</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>
<p>Implements <a class="el" href="a00030.html#abc7a3a5f8cd7082fbcad88cbb8f64cc0">ucommon::CharacterProtocol</a>.</p>
</div>
</div>
<a class="anchor" id="a6b2215f96777d0ef4a8dd2eb9fcff3b3"></a><!-- doxytag: member="ucommon::tcpstream::close" ref="a6b2215f96777d0ef4a8dd2eb9fcff3b3" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::tcpstream::close </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Close an active stream connection. </p>
<p>This does not release the socket but is a disconnect. </p>
<p>Reimplemented in <a class="el" href="a00144.html#a676a460a7b05dac2c0d5a38eefb8734d">ucommon::sstream</a>.</p>
</div>
</div>
<a class="anchor" id="a4e8dcb9d1d6ad4ffc438374e0079e9d7"></a><!-- doxytag: member="ucommon::tcpstream::open" ref="a4e8dcb9d1d6ad4ffc438374e0079e9d7" args="(char *host, char *service, unsigned segment=536)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::tcpstream::open </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>host</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>service</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>segment</em> = <code>536</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Open a stream connectoion to a host and service. </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>to connect to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>service</em> </td><td>to connect to by name or number as string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>segment</em> </td><td>buffering size to use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4805aae65525903d64f2e5aca7f373a2"></a><!-- doxytag: member="ucommon::tcpstream::open" ref="a4805aae65525903d64f2e5aca7f373a2" args="(Socket::address &address, unsigned segment=536)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::tcpstream::open </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00141.html">Socket::address</a> & </td>
<td class="paramname"> <em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>segment</em> = <code>536</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Open a stream connection to a tcp service. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>address</em> </td><td>of service to access. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>segment</em> </td><td>buffering size to use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a51871b99cf5f7373b01d0b94ae7c215a"></a><!-- doxytag: member="ucommon::tcpstream::operator bool" ref="a51871b99cf5f7373b01d0b94ae7c215a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::tcpstream::operator bool </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See if stream connection is active. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if stream is active. </dd></dl>
<p>Reimplemented from <a class="el" href="a00147.html">ucommon::StreamProtocol</a>.</p>
<p>Definition at line <a class="el" href="a00200_source.html#l00190">190</a> of file <a class="el" href="a00200_source.html">stream.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3cae3a1ce5647f6b06fecef4b7472fba"></a><!-- doxytag: member="ucommon::tcpstream::operator!" ref="a3cae3a1ce5647f6b06fecef4b7472fba" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucommon::tcpstream::operator! </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See if stream is disconnected. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if stream disconnected. </dd></dl>
<p>Reimplemented from <a class="el" href="a00147.html">ucommon::StreamProtocol</a>.</p>
<p>Definition at line <a class="el" href="a00200_source.html#l00197">197</a> of file <a class="el" href="a00200_source.html">stream.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00200_source.html">stream.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:40:08 2011 for ucommon by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
