<!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::UnixStream 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_unix_stream.html">UnixStream</a>
</div>
</div>
<div class="contents">
<h1>ost::UnixStream Class Reference</h1><!-- doxytag: class="ost::UnixStream" --><!-- doxytag: inherits="ost::Socket" -->
<p>Unix streams are used to represent Unix domain client connections to a local server for accepting client connections.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="unix_8h_source.html">unix.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ost::UnixStream:</div>
<div class="dynsection">
<div class="center">
<img src="classost_1_1_unix_stream.png" usemap="#ost::UnixStream_map" alt=""/>
<map id="ost::UnixStream_map" name="ost::UnixStream_map">
<area href="classost_1_1_socket.html" alt="ost::Socket" shape="rect" coords="56,0,158,24"/>
<area href="classost_1_1_unix_session.html" alt="ost::UnixSession" shape="rect" coords="0,112,102,136"/>
<area href="classost_1_1unixstream.html" alt="ost::unixstream" shape="rect" coords="112,112,214,136"/>
</map>
</div>
</div>
<p><a href="classost_1_1_unix_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_unix_stream.html#a47aa1e84b6b30aaf685da37d1c33333d">UnixStream</a> (<a class="el" href="classost_1_1_unix_socket.html">UnixSocket</a> &server, int size=512, bool throwflag=true, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> <a class="el" href="classost_1_1_unix_stream.html#ae7ec25f34d873ef18fd64d8b0f02cf79">timeout</a>=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a Unix domain stream by accepting a connection from a bound Unix domain socket acting as a server. <a href="#a47aa1e84b6b30aaf685da37d1c33333d"></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_unix_stream.html#ac3ab04484686582f0da458e445f8c54a">UnixStream</a> (const char *pathname, int size=512, 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">Create a Unix domain stream by connecting to a Unix domain socket. <a href="#ac3ab04484686582f0da458e445f8c54a"></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_unix_stream.html#a3a83e5c60400c15691e07cc1572f896e">setTimeout</a> (<a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> to)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the I/O operation timeout for socket I/O operations. <a href="#a3a83e5c60400c15691e07cc1572f896e"></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_unix_stream.html#a85445b9696aef793efaf149ab4c0f17a">UnixStream</a> (const <a class="el" href="classost_1_1_unix_stream.html">UnixStream</a> &source)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A copy constructor creates a new stream buffer. <a href="#a85445b9696aef793efaf149ab4c0f17a"></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_unix_stream.html#aca8dc404a29b1e82cda4668cf11a16f7">~UnixStream</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flush and empty all buffers, and then remove the allocated buffers. <a href="#aca8dc404a29b1e82cda4668cf11a16f7"></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_unix_stream.html#afb5c9e8757dd646f31ebbc9317dc009c">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="#afb5c9e8757dd646f31ebbc9317dc009c"></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_unix_stream.html#a8d15a61a6636da4e17651ebb30884183">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_unix_stream.html#ae7ec25f34d873ef18fd64d8b0f02cf79">timeout</a>=~((<a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a>) 0))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the status of pending stream data. <a href="#a8d15a61a6636da4e17651ebb30884183"></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_unix_stream.html#a47ee3a02e54d02259e2073f616b315b6">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="#a47ee3a02e54d02259e2073f616b315b6"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected 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_unix_stream.html#ad7716a7585a96013b5617737b3b6ad15">UnixStream</a> (bool throwflag=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The constructor required for "unixstream", a more C++ style version of the <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> class. <a href="#ad7716a7585a96013b5617737b3b6ad15"></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_unix_stream.html#a61c6df3222ae19b4fcd3292355a40dad">allocate</a> (int size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to allocate the buffer space needed for iostream operations. <a href="#a61c6df3222ae19b4fcd3292355a40dad"></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_unix_stream.html#a8e1d91df372138f19b184de24507cd7a">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="#a8e1d91df372138f19b184de24507cd7a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_unix_stream.html#af3f6b4f669ea0e3dca087824101545ce">underflow</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 unix domain socket connection. <a href="#af3f6b4f669ea0e3dca087824101545ce"></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_unix_stream.html#a264a06acbe32b9af460f6c27fb7d9cf9">uflow</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This streambuf method is used for doing unbuffered reads through the established unix domain socket connection when in interactive mode. <a href="#a264a06acbe32b9af460f6c27fb7d9cf9"></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_unix_stream.html#af1da2e12a8f72df5210d9508e31da2b3">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 unix domain connection. <a href="#af1da2e12a8f72df5210d9508e31da2b3"></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_unix_stream.html#a3077c8e255acdf561438c31010e96fe1">connect</a> (const char *pathname, int size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a Unix domain stream by connecting to a Unix domain socket. <a href="#a3077c8e255acdf561438c31010e96fe1"></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_unix_stream.html#a4995485ba6ee8cb82ea680b07bb7f4d5">unixstr</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="#a4995485ba6ee8cb82ea680b07bb7f4d5"></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_unix_stream.html#ae7ec25f34d873ef18fd64d8b0f02cf79">timeout</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_unix_stream.html#af46a88a033dff67d8b606462ae3b82ca">bufsize</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_unix_stream.html#aae0c867b6f05f1acb04ddf264a80a0d4">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_unix_stream.html#a9eb647ea64a38e48ab3f2bf850c8ca59">pbuf</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Unix streams are used to represent Unix domain client connections to a local server for accepting client connections. </p>
<p>The Unix stream is a C++ "stream" class, and can accept streaming of data to and from other C++ objects using the << and >> operators.</p>
<p>Unix Stream itself can be formed either by connecting to a bound network address of a Unix domain server, or can be created when "accepting" a network connection from a Unix domain server.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>Alex Pavloff <<a href="mailto:alex@pavloff.net">alex@pavloff.net</a>> streamable Unix domain socket connection. </dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ad7716a7585a96013b5617737b3b6ad15"></a><!-- doxytag: member="ost::UnixStream::UnixStream" ref="ad7716a7585a96013b5617737b3b6ad15" args="(bool throwflag=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::UnixStream::UnixStream </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>throwflag</em> = <code>true</code></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The constructor required for "unixstream", a more C++ style version of the <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> class. </p>
</div>
</div>
<a class="anchor" id="a47aa1e84b6b30aaf685da37d1c33333d"></a><!-- doxytag: member="ost::UnixStream::UnixStream" ref="a47aa1e84b6b30aaf685da37d1c33333d" args="(UnixSocket &server, int size=512, bool throwflag=true, timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::UnixStream::UnixStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_unix_socket.html">UnixSocket</a> & </td>
<td class="paramname"> <em>server</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>size</em> = <code>512</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 Unix domain stream by accepting a connection from a bound Unix domain 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>size</em> </td><td>of streaming input and output 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="ac3ab04484686582f0da458e445f8c54a"></a><!-- doxytag: member="ost::UnixStream::UnixStream" ref="ac3ab04484686582f0da458e445f8c54a" args="(const char *pathname, int size=512, bool throwflag=true, timeout_t to=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::UnixStream::UnixStream </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pathname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>size</em> = <code>512</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>Create a Unix domain stream by connecting to a Unix domain socket. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pathname</em> </td><td>path to socket </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of streaming input and output 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>to</em> </td><td>timeout for all operations. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a85445b9696aef793efaf149ab4c0f17a"></a><!-- doxytag: member="ost::UnixStream::UnixStream" ref="a85445b9696aef793efaf149ab4c0f17a" args="(const UnixStream &source)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::UnixStream::UnixStream </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_unix_stream.html">UnixStream</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>of copy. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aca8dc404a29b1e82cda4668cf11a16f7"></a><!-- doxytag: member="ost::UnixStream::~UnixStream" ref="aca8dc404a29b1e82cda4668cf11a16f7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ost::UnixStream::~UnixStream </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="a61c6df3222ae19b4fcd3292355a40dad"></a><!-- doxytag: member="ost::UnixStream::allocate" ref="a61c6df3222ae19b4fcd3292355a40dad" args="(int size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::UnixStream::allocate </td>
<td>(</td>
<td class="paramtype">int </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="a3077c8e255acdf561438c31010e96fe1"></a><!-- doxytag: member="ost::UnixStream::connect" ref="a3077c8e255acdf561438c31010e96fe1" args="(const char *pathname, int size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::UnixStream::connect </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pathname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>size</em></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 Unix domain stream by connecting to a Unix domain socket. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pathname</em> </td><td>path to socket </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of streaming input and output buffers. </td></tr>
</table>
</dd>
</dl>
<p>Referenced by <a class="el" href="unix_8h_source.html#l00304">ost::unixstream::open()</a>.</p>
</div>
</div>
<a class="anchor" id="a8e1d91df372138f19b184de24507cd7a"></a><!-- doxytag: member="ost::UnixStream::endStream" ref="a8e1d91df372138f19b184de24507cd7a" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::UnixStream::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>
</div>
</div>
<a class="anchor" id="a47ee3a02e54d02259e2073f616b315b6"></a><!-- doxytag: member="ost::UnixStream::getBufferSize" ref="a47ee3a02e54d02259e2073f616b315b6" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ost::UnixStream::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>
<p>References <a class="el" href="unix_8h_source.html#l00125">bufsize</a>.</p>
</div>
</div>
<a class="anchor" id="a8d15a61a6636da4e17651ebb30884183"></a><!-- doxytag: member="ost::UnixStream::isPending" ref="a8d15a61a6636da4e17651ebb30884183" args="(Pending pend, timeout_t timeout=~((timeout_t) 0))" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::UnixStream::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>~((<a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a>) 0)</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>
</div>
</div>
<a class="anchor" id="af1da2e12a8f72df5210d9508e31da2b3"></a><!-- doxytag: member="ost::UnixStream::overflow" ref="af1da2e12a8f72df5210d9508e31da2b3" args="(int ch)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ost::UnixStream::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 unix domain 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="a3a83e5c60400c15691e07cc1572f896e"></a><!-- doxytag: member="ost::UnixStream::setTimeout" ref="a3a83e5c60400c15691e07cc1572f896e" args="(timeout_t to)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::UnixStream::setTimeout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>to</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>to</em> </td><td>timeout to set. </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="unix_8h_source.html#l00124">timeout</a>.</p>
</div>
</div>
<a class="anchor" id="afb5c9e8757dd646f31ebbc9317dc009c"></a><!-- doxytag: member="ost::UnixStream::sync" ref="afb5c9e8757dd646f31ebbc9317dc009c" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ost::UnixStream::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="a264a06acbe32b9af460f6c27fb7d9cf9"></a><!-- doxytag: member="ost::UnixStream::uflow" ref="a264a06acbe32b9af460f6c27fb7d9cf9" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ost::UnixStream::uflow </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>This streambuf method is used for doing unbuffered reads through the established unix domain 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 unix domain socket connection, EOF if not connected. </dd></dl>
</div>
</div>
<a class="anchor" id="af3f6b4f669ea0e3dca087824101545ce"></a><!-- doxytag: member="ost::UnixStream::underflow" ref="af3f6b4f669ea0e3dca087824101545ce" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int ost::UnixStream::underflow </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 unix domain socket connection. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>char from get buffer, EOF if not connected. </dd></dl>
</div>
</div>
<a class="anchor" id="a4995485ba6ee8cb82ea680b07bb7f4d5"></a><!-- doxytag: member="ost::UnixStream::unixstr" ref="a4995485ba6ee8cb82ea680b07bb7f4d5" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::iostream* ost::UnixStream::unixstr </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>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="af46a88a033dff67d8b606462ae3b82ca"></a><!-- doxytag: member="ost::UnixStream::bufsize" ref="af46a88a033dff67d8b606462ae3b82ca" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classost_1_1_unix_stream.html#af46a88a033dff67d8b606462ae3b82ca">ost::UnixStream::bufsize</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="unix_8h_source.html#l00260">getBufferSize()</a>.</p>
</div>
</div>
<a class="anchor" id="aae0c867b6f05f1acb04ddf264a80a0d4"></a><!-- doxytag: member="ost::UnixStream::gbuf" ref="aae0c867b6f05f1acb04ddf264a80a0d4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="classost_1_1_unix_stream.html#aae0c867b6f05f1acb04ddf264a80a0d4">ost::UnixStream::gbuf</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a9eb647ea64a38e48ab3f2bf850c8ca59"></a><!-- doxytag: member="ost::UnixStream::pbuf" ref="a9eb647ea64a38e48ab3f2bf850c8ca59" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * <a class="el" href="classost_1_1_unix_stream.html#a9eb647ea64a38e48ab3f2bf850c8ca59">ost::UnixStream::pbuf</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae7ec25f34d873ef18fd64d8b0f02cf79"></a><!-- doxytag: member="ost::UnixStream::timeout" ref="ae7ec25f34d873ef18fd64d8b0f02cf79" 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_unix_stream.html#ae7ec25f34d873ef18fd64d8b0f02cf79">ost::UnixStream::timeout</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="unix_8h_source.html#l00221">setTimeout()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="unix_8h_source.html">unix.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:57:40 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
>
2010.1
>
x86_64
>
media
>
main-updates
>
by-pkgid
>
f36f42783f75191f5f2d47f1e8c5504e
>
files
>
439
