<!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::UnixSession 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_unix_session.html">UnixSession</a></div> <h1>ost::UnixSession Class Reference</h1><!-- doxytag: class="ost::UnixSession" --><!-- doxytag: inherits="ost::Thread,ost::UnixStream" -->The Unix domain session is used to primarily to represent a client connection that can be managed on a seperate thread.Threaded streamable unix domain socket with non-blocking constructor. <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::UnixSession: <p><center><img src="classost_1_1_unix_session.png" usemap="#ost::UnixSession_map" border="0" alt=""></center> <map name="ost::UnixSession_map"> <area href="classost_1_1_thread.html" alt="ost::Thread" shape="rect" coords="0,56,102,80"> <area href="classost_1_1_unix_stream.html" alt="ost::UnixStream" shape="rect" coords="112,56,214,80"> <area href="classost_1_1_socket.html" alt="ost::Socket" shape="rect" coords="112,0,214,24"> </map> <a href="classost_1_1_unix_session-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_unix_session.html#49e49dee2cc4b595ae78397d592b4305">UnixSession</a> (const char *pathname, int size=512, int pri=0, int stack=0)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a Unix domain socket that will be connected to a local server server and that will execute under it's own thread. <a href="#49e49dee2cc4b595ae78397d592b4305"></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_unix_session.html#6e9d0fe9b2b5a324240d40c6c7fb1fef">UnixSession</a> (<a class="el" href="classost_1_1_unix_socket.html">UnixSocket</a> &server, int size=512, int pri=0, int stack=0)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a Unix domain socket from a bound Unix domain server by accepting a pending connection from that server and execute a thread for the accepted connection. <a href="#6e9d0fe9b2b5a324240d40c6c7fb1fef"></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_unix_session.html#5e92890e3aa3266754531713216ba983">~UnixSession</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <a href="#5e92890e3aa3266754531713216ba983"></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">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_unix_session.html#5906649d95a9f93bd5bdb0f1d68b28f1">waitConnection</a> (<a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> <a class="el" href="classost_1_1_unix_stream.html#e7ec25f34d873ef18fd64d8b0f02cf79">timeout</a>=TIMEOUT_INF)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Normally called during the thread Initial() method by default, this will wait for the socket connection to complete when connecting to a remote socket. <a href="#5906649d95a9f93bd5bdb0f1d68b28f1"></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_unix_session.html#5762091d1418fca6b4970c9c5a5b347f">initial</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The initial method is used to esablish a connection when delayed completion is used. <a href="#5762091d1418fca6b4970c9c5a5b347f"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> The Unix domain session is used to primarily to represent a client connection that can be managed on a seperate thread.Threaded streamable unix domain socket with non-blocking constructor. <p> The Unix domain session also supports a non-blocking connection scheme which prevents blocking during the constructor and moving the process of completing a connection into the thread that executes for the session.<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="49e49dee2cc4b595ae78397d592b4305"></a><!-- doxytag: member="ost::UnixSession::UnixSession" ref="49e49dee2cc4b595ae78397d592b4305" args="(const char *pathname, int size=512, int pri=0, int stack=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::UnixSession::UnixSession </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>size</em> = <code>512</code>, </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>pri</em> = <code>0</code>, </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>stack</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 Unix domain socket that will be connected to a local server server and that will execute under it's own thread. <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>path to socket </td></tr> <tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of streaming buffer. </td></tr> <tr><td valign="top"></td><td valign="top"><em>pri</em> </td><td>execution priority relative to parent. </td></tr> <tr><td valign="top"></td><td valign="top"><em>stack</em> </td><td>allocation needed on some platforms. </td></tr> </table> </dl> </td> </tr> </table> <a class="anchor" name="6e9d0fe9b2b5a324240d40c6c7fb1fef"></a><!-- doxytag: member="ost::UnixSession::UnixSession" ref="6e9d0fe9b2b5a324240d40c6c7fb1fef" args="(UnixSocket &server, int size=512, int pri=0, int stack=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::UnixSession::UnixSession </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>server</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>size</em> = <code>512</code>, </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>pri</em> = <code>0</code>, </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>stack</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 Unix domain socket from a bound Unix domain server by accepting a pending connection from that server and execute a thread for the accepted 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>server</em> </td><td>unix domain socket to accept a connection from. </td></tr> <tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of streaming buffer. </td></tr> <tr><td valign="top"></td><td valign="top"><em>pri</em> </td><td>execution priority relative to parent. </td></tr> <tr><td valign="top"></td><td valign="top"><em>stack</em> </td><td>allocation needed on some platforms. </td></tr> </table> </dl> </td> </tr> </table> <a class="anchor" name="5e92890e3aa3266754531713216ba983"></a><!-- doxytag: member="ost::UnixSession::~UnixSession" ref="5e92890e3aa3266754531713216ba983" 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::UnixSession::~UnixSession </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> Virtual destructor. <p> </td> </tr> </table> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="5762091d1418fca6b4970c9c5a5b347f"></a><!-- doxytag: member="ost::UnixSession::initial" ref="5762091d1418fca6b4970c9c5a5b347f" 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::UnixSession::initial </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, virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> The initial method is used to esablish a connection when delayed completion is used. <p> This assures the constructor terminates without having to wait for a connection request to complete. <p> Reimplemented from <a class="el" href="classost_1_1_thread.html#300c229e76725eeddc69867f7ecea91f">ost::Thread</a>. </td> </tr> </table> <a class="anchor" name="5906649d95a9f93bd5bdb0f1d68b28f1"></a><!-- doxytag: member="ost::UnixSession::waitConnection" ref="5906649d95a9f93bd5bdb0f1d68b28f1" args="(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">int ost::UnixSession::waitConnection </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>timeout</em> = <code>TIMEOUT_INF</code> </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> Normally called during the thread Initial() method by default, this will wait for the socket connection to complete when connecting to a remote socket. <p> One might wish to use <a class="el" href="classost_1_1_socket.html#16eb72794ce956b2af6b935eb59b2e24">setCompletion()</a> to change the socket back to blocking I/O calls after the connection completes. To implement the session one must create a derived class which implements Run().<p> <dl compact><dt><b>Returns:</b></dt><dd>0 if successful, -1 if timed out. </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>timeout</em> </td><td>to wait for completion in milliseconds. </td></tr> </table> </dl> </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>