<!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::UnixSocket 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_socket.html">UnixSocket</a>
</div>
</div>
<div class="contents">
<h1>ost::UnixSocket Class Reference</h1><!-- doxytag: class="ost::UnixSocket" --><!-- doxytag: inherits="ost::Socket" -->
<p>Unix domain sockets are used for stream based connected sessions between processes on the same machine.
<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::UnixSocket:</div>
<div class="dynsection">
<div class="center">
<img src="classost_1_1_unix_socket.png" usemap="#ost::UnixSocket_map" alt=""/>
<map id="ost::UnixSocket_map" name="ost::UnixSocket_map">
<area href="classost_1_1_socket.html" alt="ost::Socket" shape="rect" coords="0,0,96,24"/>
</map>
</div>
</div>
<p><a href="classost_1_1_unix_socket-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_socket.html#ad247697df0e9595edda1811ce2cbda49">UnixSocket</a> (const char *pathname, int backlog=5)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A Unix domain "server" is created as a Unix domain socket that is bound to a pathname and that has a backlog queue to listen for connection requests. <a href="#ad247697df0e9595edda1811ce2cbda49"></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_socket.html#adcf40179cedb61960eb7dd4fa4bbd82b">isPendingConnection</a> (<a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=~((<a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a>) 0))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to wait for pending connection requests. <a href="#adcf40179cedb61960eb7dd4fa4bbd82b"></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_socket.html#a130c4df2a9f65959eb3df4e92762941a">~UnixSocket</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Use base socket handler for ending this socket. <a href="#a130c4df2a9f65959eb3df4e92762941a"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></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_socket.html#a38e4a88a67d37e1c62594bb7c8d16041">close</a> (void)</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></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_socket.html#af38b52b046cfe425011e7a0f0ab900cd">path</a></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_unix_socket.html#a9d8c3d489c258a33d9fc3fcf2d25e6d9">UnixStream</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_unix_socket.html#a9884a27b35e263e19e4acf2cb06c4071">SocketPort</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_unix_socket.html#ad61d60ad260c2cbbd0e85b2616e19315">unixstream</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Unix domain sockets are used for stream based connected sessions between processes on the same machine. </p>
<p>An implicit and unique <a class="el" href="classost_1_1_unix_socket.html" title="Unix domain sockets are used for stream based connected sessions between processes...">UnixSocket</a> object exists in Common C++ to represent a bound Unix domain socket acting as a "server" for receiving connection requests. This class is not part of <a class="el" href="classost_1_1_unix_stream.html" title="Unix streams are used to represent Unix domain client connections to a local server...">UnixStream</a> because such objects normally perform no physical I/O (read or write operations) other than to specify a listen backlog queue and perform "accept" operations for pending connections.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>Alex Pavloff <<a href="mailto:alex@pavloff.net">alex@pavloff.net</a>> bound server for Unix domain streams and sessions. </dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ad247697df0e9595edda1811ce2cbda49"></a><!-- doxytag: member="ost::UnixSocket::UnixSocket" ref="ad247697df0e9595edda1811ce2cbda49" args="(const char *pathname, int backlog=5)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::UnixSocket::UnixSocket </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>backlog</em> = <code>5</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A Unix domain "server" is created as a Unix domain socket that is bound to a pathname and that has a backlog queue to listen for connection requests. </p>
<p>If the server cannot be created, an exception is thrown.</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>backlog</em> </td><td>size of connection request queue. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a130c4df2a9f65959eb3df4e92762941a"></a><!-- doxytag: member="ost::UnixSocket::~UnixSocket" ref="a130c4df2a9f65959eb3df4e92762941a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ost::UnixSocket::~UnixSocket </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Use base socket handler for ending this socket. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a38e4a88a67d37e1c62594bb7c8d16041"></a><!-- doxytag: member="ost::UnixSocket::close" ref="a38e4a88a67d37e1c62594bb7c8d16041" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::UnixSocket::close </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">
</div>
</div>
<a class="anchor" id="adcf40179cedb61960eb7dd4fa4bbd82b"></a><!-- doxytag: member="ost::UnixSocket::isPendingConnection" ref="adcf40179cedb61960eb7dd4fa4bbd82b" args="(timeout_t timeout=~((timeout_t) 0))" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::UnixSocket::isPendingConnection </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>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used to wait for pending connection requests. </p>
<p>not const -- jfc </p>
<p>References <a class="el" href="classost_1_1_socket.html#a8eb84be4b5cc91731c16be4f32f5bf3d">ost::Socket::isPending()</a>, and <a class="el" href="socket_8h_source.html#l00175">ost::Socket::pendingInput</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a9884a27b35e263e19e4acf2cb06c4071"></a><!-- doxytag: member="ost::UnixSocket::SocketPort" ref="a9884a27b35e263e19e4acf2cb06c4071" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classost_1_1_socket_port.html">SocketPort</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad61d60ad260c2cbbd0e85b2616e19315"></a><!-- doxytag: member="ost::UnixSocket::unixstream" ref="ad61d60ad260c2cbbd0e85b2616e19315" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classost_1_1unixstream.html">unixstream</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a9d8c3d489c258a33d9fc3fcf2d25e6d9"></a><!-- doxytag: member="ost::UnixSocket::UnixStream" ref="a9d8c3d489c258a33d9fc3fcf2d25e6d9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classost_1_1_unix_stream.html">UnixStream</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="af38b52b046cfe425011e7a0f0ab900cd"></a><!-- doxytag: member="ost::UnixSocket::path" ref="af38b52b046cfe425011e7a0f0ab900cd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="classost_1_1_unix_socket.html#af38b52b046cfe425011e7a0f0ab900cd">ost::UnixSocket::path</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</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>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
ed376d6842ea322c25405e7c23b3bc12
>
files
>
436
