<!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_1unixstream.html">unixstream</a> </div> </div> <div class="contents"> <h1>ost::unixstream Class Reference</h1><!-- doxytag: class="ost::unixstream" --><!-- doxytag: inherits="ost::UnixStream" --> <p>A more natural C++ "unixstream" class for use by non-threaded applications. <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_1unixstream.png" usemap="#ost::unixstream_map" alt=""/> <map id="ost::unixstream_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> </div> </div> <p><a href="classost_1_1unixstream-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_1unixstream.html#a19250bd6a03d44a24acbb72b395e733c">unixstream</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an unopened "tcpstream" object. <a href="#a19250bd6a03d44a24acbb72b395e733c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1unixstream.html#ae9622b71dd27a2e7758e67ae170f7045">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="#ae9622b71dd27a2e7758e67ae170f7045"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1unixstream.html#a11812e2a114c71c8046f29ba6346ca89">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="#a11812e2a114c71c8046f29ba6346ca89"></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_1unixstream.html#a36912330fc233b99b6ea5d6a64a8c5f8">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="#a36912330fc233b99b6ea5d6a64a8c5f8"></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_1unixstream.html#a2c7e711ac75c5e8b4d9e751c6b3657a4">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="#a2c7e711ac75c5e8b4d9e751c6b3657a4"></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_1unixstream.html#ac5170d735329b96a75afa7e5164c4340">close</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Close the active tcp stream connection. <a href="#ac5170d735329b96a75afa7e5164c4340"></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_1unixstream.html#ae2fd7abfaf4da197090ba24f42fa255d">operator!</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Test to see if stream is open. <a href="#ae2fd7abfaf4da197090ba24f42fa255d"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>A more natural C++ "unixstream" class for use by non-threaded applications. </p> <p>This class behaves a lot more like fstream and similar classes.</p> <dl class="author"><dt><b>Author:</b></dt><dd>Alex Pavloff <<a href="mailto:alex@pavloff.net">alex@pavloff.net</a>> C++ "fstream" style unixstream class. </dd></dl> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a19250bd6a03d44a24acbb72b395e733c"></a><!-- doxytag: member="ost::unixstream::unixstream" ref="a19250bd6a03d44a24acbb72b395e733c" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::unixstream::unixstream </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Construct an unopened "tcpstream" object. </p> </div> </div> <a class="anchor" id="ae9622b71dd27a2e7758e67ae170f7045"></a><!-- doxytag: member="ost::unixstream::unixstream" ref="ae9622b71dd27a2e7758e67ae170f7045" args="(const char *pathname, int buffer=512)" --> <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>buffer</em> = <code>512</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Construct and "open" (connect) the tcp stream to a remote 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>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> </dd> </dl> </div> </div> <a class="anchor" id="a11812e2a114c71c8046f29ba6346ca89"></a><!-- doxytag: member="ost::unixstream::unixstream" ref="a11812e2a114c71c8046f29ba6346ca89" args="(UnixSocket &unixsock, int buffer=512)" --> <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>unixsock</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>buffer</em> = <code>512</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Construct and "accept" (connect) the tcp stream through a server. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>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> </dd> </dl> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ac5170d735329b96a75afa7e5164c4340"></a><!-- doxytag: member="ost::unixstream::close" ref="ac5170d735329b96a75afa7e5164c4340" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ost::unixstream::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 the active tcp stream connection. </p> </div> </div> <a class="anchor" id="a2c7e711ac75c5e8b4d9e751c6b3657a4"></a><!-- doxytag: member="ost::unixstream::open" ref="a2c7e711ac75c5e8b4d9e751c6b3657a4" args="(UnixSocket &unixsock, int buffer=512)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ost::unixstream::open </td> <td>(</td> <td class="paramtype"><a class="el" href="classost_1_1_unix_socket.html">UnixSocket</a> & </td> <td class="paramname"> <em>unixsock</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>buffer</em> = <code>512</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 tcp stream connection by accepting a tcp 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>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> </dd> </dl> </div> </div> <a class="anchor" id="a36912330fc233b99b6ea5d6a64a8c5f8"></a><!-- doxytag: member="ost::unixstream::open" ref="a36912330fc233b99b6ea5d6a64a8c5f8" args="(const char *pathname, int buffer=512)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ost::unixstream::open </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>buffer</em> = <code>512</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Open a tcp stream connection. </p> <p>This will close the currently active connection first.</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>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> </dd> </dl> <p>References <a class="el" href="classost_1_1_unix_stream.html#a3077c8e255acdf561438c31010e96fe1">ost::UnixStream::connect()</a>.</p> </div> </div> <a class="anchor" id="ae2fd7abfaf4da197090ba24f42fa255d"></a><!-- doxytag: member="ost::unixstream::operator!" ref="ae2fd7abfaf4da197090ba24f42fa255d" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool ost::unixstream::operator! </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Test to see if stream is open. </p> <p>Reimplemented from <a class="el" href="classost_1_1_socket.html#a5e2c05b34bded0db1bcdcf08bd44f052">ost::Socket</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:55:48 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>