<!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>ucommon: ucommon::ListenSocket 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="main.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>Data Structures</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>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00208.html">ucommon</a>::<a class="el" href="a00068.html">ListenSocket</a>
</div>
</div>
<div class="contents">
<h1>ucommon::ListenSocket Class Reference</h1><!-- doxytag: class="ucommon::ListenSocket" --><!-- doxytag: inherits="ucommon::Socket" -->
<p>A bound socket used to listen for inbound socket connections.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00198_source.html">socket.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucommon::ListenSocket:</div>
<div class="dynsection">
<div class="center"><img src="a00411.png" border="0" usemap="#ucommon_1_1_listen_socket_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1_listen_socket_inherit__map" id="ucommon_1_1_listen_socket_inherit__map">
<area shape="rect" id="node5" href="a00152.html" title="A generic tcp server class." alt="" coords="20,155,223,181"/><area shape="rect" id="node2" href="a00140.html" title="A generic socket base class." alt="" coords="36,5,207,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucommon::ListenSocket:</div>
<div class="dynsection">
<div class="center"><img src="a00412.png" border="0" usemap="#ucommon_1_1_listen_socket_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1_listen_socket_coll__map" id="ucommon_1_1_listen_socket_coll__map">
<area shape="rect" id="node2" href="a00140.html" title="A generic socket base class." alt="" coords="36,5,207,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<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">socket_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00068.html#a12dc14f00070708b03fa0674c4c53454">accept</a> (struct sockaddr_storage *<a class="el" href="a00141.html">address</a>=NULL) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Accept a socket connection. <a href="#a12dc14f00070708b03fa0674c4c53454"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">socket_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00068.html#a22a24b2b2ca2e53f1666517a1a5df977">getsocket</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the socket descriptor of the listener. <a href="#a22a24b2b2ca2e53f1666517a1a5df977"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00068.html#affd7d23b8c3737f0b9e25c975e20c81b">ListenSocket</a> (const char *<a class="el" href="a00141.html">address</a>, const char *service, unsigned backlog=5, int family=0, int type=0, int protocol=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create and bind a listener socket. <a href="#affd7d23b8c3737f0b9e25c975e20c81b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00068.html#a8d495f0942321a4ce5aec10af0c9771a">operator socket_t</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the socket descriptor of the listener. <a href="#a8d495f0942321a4ce5aec10af0c9771a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">socket_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00068.html#ac96f1f17d672c69b1a69b9d235128077">operator*</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the socket descriptor of the listener by pointer reference. <a href="#ac96f1f17d672c69b1a69b9d235128077"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00068.html#a5b0eb097b487199cd00cdcd6a570adbd">waitConnection</a> (<a class="el" href="a00194.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=<a class="el" href="a00162.html#ad3d270c59686a8af48b731d389c65b1c">Timer::inf</a>) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wait for a pending connection. <a href="#a5b0eb097b487199cd00cdcd6a570adbd"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static socket_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00068.html#aa62cfd39c4803a267ae3b86ae7992294">create</a> (const char *<a class="el" href="a00141.html">address</a>, const char *service, unsigned backlog=5, int family=0, int type=0, int protocol=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a listen socket directly. <a href="#aa62cfd39c4803a267ae3b86ae7992294"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A bound socket used to listen for inbound socket connections. </p>
<p>This class is commonly used for TCP and DCCP listener sockets. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00198_source.html#l01660">1660</a> of file <a class="el" href="a00198_source.html">socket.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="affd7d23b8c3737f0b9e25c975e20c81b"></a><!-- doxytag: member="ucommon::ListenSocket::ListenSocket" ref="affd7d23b8c3737f0b9e25c975e20c81b" args="(const char *address, const char *service, unsigned backlog=5, int family=0, int type=0, int protocol=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::ListenSocket::ListenSocket </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>service</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>backlog</em> = <code>5</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>family</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>type</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>protocol</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 and bind a listener 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>address</em> </td><td>to bind on or "*" for all. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>service</em> </td><td>port to bind listener. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>backlog</em> </td><td>size for buffering pending connections. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>family</em> </td><td>of socket. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>of socket. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>protocol</em> </td><td>for socket if not TCPIP. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a12dc14f00070708b03fa0674c4c53454"></a><!-- doxytag: member="ucommon::ListenSocket::accept" ref="a12dc14f00070708b03fa0674c4c53454" args="(struct sockaddr_storage *address=NULL) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">socket_t ucommon::ListenSocket::accept </td>
<td>(</td>
<td class="paramtype">struct sockaddr_storage * </td>
<td class="paramname"> <em>address</em> = <code>NULL</code></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Accept a socket 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>address</em> </td><td>to save peer connecting. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>socket descriptor of connected socket. </dd></dl>
</div>
</div>
<a class="anchor" id="aa62cfd39c4803a267ae3b86ae7992294"></a><!-- doxytag: member="ucommon::ListenSocket::create" ref="aa62cfd39c4803a267ae3b86ae7992294" args="(const char *address, const char *service, unsigned backlog=5, int family=0, int type=0, int protocol=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static socket_t ucommon::ListenSocket::create </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>service</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>backlog</em> = <code>5</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>family</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>type</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>protocol</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a listen socket directly. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>address</em> </td><td>to bind on or "*" for all. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>service</em> </td><td>port to bind listener. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>backlog</em> </td><td>size for buffering pending connections. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>family</em> </td><td>of socket. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>of socket. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>protocol</em> </td><td>for socket if not TCPIP. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>bound and listened to socket. </dd></dl>
</div>
</div>
<a class="anchor" id="a22a24b2b2ca2e53f1666517a1a5df977"></a><!-- doxytag: member="ucommon::ListenSocket::getsocket" ref="a22a24b2b2ca2e53f1666517a1a5df977" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">socket_t ucommon::ListenSocket::getsocket </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>Get the socket descriptor of the listener. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>socket descriptor. </dd></dl>
<p>Definition at line <a class="el" href="a00198_source.html#l01719">1719</a> of file <a class="el" href="a00198_source.html">socket.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8d495f0942321a4ce5aec10af0c9771a"></a><!-- doxytag: member="ucommon::ListenSocket::operator socket_t" ref="a8d495f0942321a4ce5aec10af0c9771a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::ListenSocket::operator socket_t </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the socket descriptor of the listener. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>socket descriptor. </dd></dl>
<p>Reimplemented from <a class="el" href="a00140.html#a052529d07ea8d602b84f6dc6e13059cf">ucommon::Socket</a>.</p>
<p>Definition at line <a class="el" href="a00198_source.html#l01705">1705</a> of file <a class="el" href="a00198_source.html">socket.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac96f1f17d672c69b1a69b9d235128077"></a><!-- doxytag: member="ucommon::ListenSocket::operator*" ref="ac96f1f17d672c69b1a69b9d235128077" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">socket_t ucommon::ListenSocket::operator* </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the socket descriptor of the listener by pointer reference. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>socket descriptor. </dd></dl>
<p>Reimplemented from <a class="el" href="a00140.html#a14c3ced56f4e1f47f810894fa05d904d">ucommon::Socket</a>.</p>
<p>Definition at line <a class="el" href="a00198_source.html#l01712">1712</a> of file <a class="el" href="a00198_source.html">socket.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5b0eb097b487199cd00cdcd6a570adbd"></a><!-- doxytag: member="ucommon::ListenSocket::waitConnection" ref="a5b0eb097b487199cd00cdcd6a570adbd" args="(timeout_t timeout=Timer::inf) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucommon::ListenSocket::waitConnection </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00194.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timeout</em> = <code><a class="el" href="a00162.html#ad3d270c59686a8af48b731d389c65b1c">Timer::inf</a></code></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Wait for a pending 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>timeout</em> </td><td>to wait. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true when acceptable connection is pending. </dd></dl>
<p>Definition at line <a class="el" href="a00198_source.html#l01698">1698</a> of file <a class="el" href="a00198_source.html">socket.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00198_source.html">socket.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:39:41 2011 for ucommon 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>
