<!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::unixstream 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_1unixstream.html">unixstream</a></div>
<h1>ost::unixstream Class Reference</h1><!-- doxytag: class="ost::unixstream" --><!-- doxytag: inherits="ost::UnixStream" -->A more natural C++ "unixstream" class for use by non-threaded applications.C++ "fstream" style unixstream class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="unix_8h-source.html">unix.h</a>></code>
<p>
<p>Inheritance diagram for ost::unixstream:
<p><center><img src="classost_1_1unixstream.png" usemap="#ost::unixstream_map" border="0" alt=""></center>
<map name="ost::unixstream_map">
<area href="classost_1_1_unix_stream.html" alt="ost::UnixStream" shape="rect" coords="0,56,97,80">
<area href="classost_1_1_socket.html" alt="ost::Socket" shape="rect" coords="0,0,97,24">
</map>
<a href="classost_1_1unixstream-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_1unixstream.html#19250bd6a03d44a24acbb72b395e733c">unixstream</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an unopened "tcpstream" object. <a href="#19250bd6a03d44a24acbb72b395e733c"></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_1unixstream.html#e9622b71dd27a2e7758e67ae170f7045">unixstream</a> (const char *pathname, int buffer=512)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct and "open" (connect) the tcp stream to a remote socket. <a href="#e9622b71dd27a2e7758e67ae170f7045"></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_1unixstream.html#11812e2a114c71c8046f29ba6346ca89">unixstream</a> (<a class="el" href="classost_1_1_unix_socket.html">UnixSocket</a> &unixsock, int buffer=512)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct and "accept" (connect) the tcp stream through a server. <a href="#11812e2a114c71c8046f29ba6346ca89"></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_1unixstream.html#36912330fc233b99b6ea5d6a64a8c5f8">open</a> (const char *pathname, int buffer=512)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a tcp stream connection. <a href="#36912330fc233b99b6ea5d6a64a8c5f8"></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_1unixstream.html#2c7e711ac75c5e8b4d9e751c6b3657a4">open</a> (<a class="el" href="classost_1_1_unix_socket.html">UnixSocket</a> &unixsock, int buffer=512)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a tcp stream connection by accepting a tcp socket. <a href="#2c7e711ac75c5e8b4d9e751c6b3657a4"></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_1unixstream.html#c5170d735329b96a75afa7e5164c4340">close</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the active tcp stream connection. <a href="#c5170d735329b96a75afa7e5164c4340"></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_1unixstream.html#e2fd7abfaf4da197090ba24f42fa255d">operator!</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test to see if stream is open. <a href="#e2fd7abfaf4da197090ba24f42fa255d"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A more natural C++ "unixstream" class for use by non-threaded applications.C++ "fstream" style unixstream class.
<p>
This class behaves a lot more like fstream and similar classes.<p>
<dl compact><dt><b>Author:</b></dt><dd>Alex Pavloff <<a href="mailto:alex@pavloff.net">alex@pavloff.net</a>> </dd></dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="19250bd6a03d44a24acbb72b395e733c"></a><!-- doxytag: member="ost::unixstream::unixstream" ref="19250bd6a03d44a24acbb72b395e733c" 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">ost::unixstream::unixstream </td>
<td class="md" valign="top">( </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>
Construct an unopened "tcpstream" object.
<p>
</td>
</tr>
</table>
<a class="anchor" name="e9622b71dd27a2e7758e67ae170f7045"></a><!-- doxytag: member="ost::unixstream::unixstream" ref="e9622b71dd27a2e7758e67ae170f7045" args="(const char *pathname, int buffer=512)" --><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::unixstream::unixstream </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>pathname</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>buffer</em> = <code>512</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 and "open" (connect) the tcp stream to a remote socket.
<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>pathname</em> </td><td>pathname to socket file </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>size for streaming (optional). </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="11812e2a114c71c8046f29ba6346ca89"></a><!-- doxytag: member="ost::unixstream::unixstream" ref="11812e2a114c71c8046f29ba6346ca89" args="(UnixSocket &unixsock, int buffer=512)" --><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::unixstream::unixstream </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_unix_socket.html">UnixSocket</a> & </td>
<td class="mdname" nowrap> <em>unixsock</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>buffer</em> = <code>512</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 and "accept" (connect) the tcp stream through a 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>unixsock</em> </td><td>socket to accept from. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>size for streaming (optional). </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c5170d735329b96a75afa7e5164c4340"></a><!-- doxytag: member="ost::unixstream::close" ref="c5170d735329b96a75afa7e5164c4340" 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::unixstream::close </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>
Close the active tcp stream connection.
<p>
</td>
</tr>
</table>
<a class="anchor" name="2c7e711ac75c5e8b4d9e751c6b3657a4"></a><!-- doxytag: member="ost::unixstream::open" ref="2c7e711ac75c5e8b4d9e751c6b3657a4" args="(UnixSocket &unixsock, int buffer=512)" --><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::unixstream::open </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_unix_socket.html">UnixSocket</a> & </td>
<td class="mdname" nowrap> <em>unixsock</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>buffer</em> = <code>512</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>
Open a tcp stream connection by accepting a tcp socket.
<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>unixsock</em> </td><td>socket to accept from. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>size for streaming (optional) </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="36912330fc233b99b6ea5d6a64a8c5f8"></a><!-- doxytag: member="ost::unixstream::open" ref="36912330fc233b99b6ea5d6a64a8c5f8" args="(const char *pathname, int buffer=512)" --><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::unixstream::open </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>pathname</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>buffer</em> = <code>512</code></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>
Open a tcp stream connection.
<p>
This will close the currently active connection first.<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>pathname</em> </td><td>pathname to socket file </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>size for streaming (optional) </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="e2fd7abfaf4da197090ba24f42fa255d"></a><!-- doxytag: member="ost::unixstream::operator!" ref="e2fd7abfaf4da197090ba24f42fa255d" args="() 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">bool ost::unixstream::operator! </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Test to see if stream is open.
<p>
<p>
Reimplemented from <a class="el" href="classost_1_1_socket.html#5e2c05b34bded0db1bcdcf08bd44f052">ost::Socket</a>. </td>
</tr>
</table>
<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></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:58 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>
