<!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::DCCPSocket 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_d_c_c_p_socket.html">DCCPSocket</a>
</div>
</div>
<div class="contents">
<h1>ost::DCCPSocket Class Reference</h1><!-- doxytag: class="ost::DCCPSocket" --><!-- doxytag: inherits="ost::Socket" -->
<p>DCCP sockets are used for stream based connected sessions between two sockets.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="socket_8h_source.html">socket.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ost::DCCPSocket:</div>
<div class="dynsection">
<div class="center">
<img src="classost_1_1_d_c_c_p_socket.png" usemap="#ost::DCCPSocket_map" alt=""/>
<map id="ost::DCCPSocket_map" name="ost::DCCPSocket_map">
<area href="classost_1_1_socket.html" alt="ost::Socket" shape="rect" coords="0,0,107,24"/>
</map>
</div>
</div>
<p><a href="classost_1_1_d_c_c_p_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">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_d_c_c_p_socket.html#a93e7dcb9974093b34a24a955d18299c2">onAccept</a> (const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> &ia, <a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A method to call in a derived <a class="el" href="classost_1_1_d_c_c_p_socket.html" title="DCCP sockets are used for stream based connected sessions between two sockets.">DCCPSocket</a> class that is acting as a server when a connection request is being accepted. <a href="#a93e7dcb9974093b34a24a955d18299c2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_d_c_c_p_socket.html#a95a9441c6e7de26329950370b2f92343">onAccept</a> (const <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> &ia, <a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_d_c_c_p_socket.html#a8121a7ac2a388a35ed30177d35361893">getIPV4Sender</a> (<a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_d_c_c_p_socket.html#a5a3a4390c87849adb3119ad5c1210dd4">getIPV6Sender</a> (<a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_d_c_c_p_socket.html#aa05194dc6aa07fa995f12b23f55717b7">DCCPSocket</a> (const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> &bind, <a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port, unsigned backlog=5)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A DCCP "server" is created as a DCCP socket that is bound to a hardware address and port number on the local machine and that has a backlog queue to listen for remote connection requests. <a href="#aa05194dc6aa07fa995f12b23f55717b7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_d_c_c_p_socket.html#af7f1b1a294d8b0d237930318248f0f83">DCCPSocket</a> (const <a class="el" href="classost_1_1_i_p_v6_address.html">IPV6Address</a> &bind, <a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port, unsigned backlog=5)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_d_c_c_p_socket.html#a6a05eda5d5acb23c17bed72f48fa04b0">DCCPSocket</a> (const char *name, <a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">Family</a> family=IPV4, unsigned backlog=5)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a named dccp socket by service and/or interface id. <a href="#a6a05eda5d5acb23c17bed72f48fa04b0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_d_c_c_p_socket.html#ac2726df223429cd35f489bdaeb1c2c66">DCCPSocket</a> (<a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">Family</a> family=IPV4)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an unconnected ephemeral DCCP client socket. <a href="#ac2726df223429cd35f489bdaeb1c2c66"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_d_c_c_p_socket.html#a482efc81f69bb1714246961e9428f355">DCCPSocket</a> (<a class="el" href="classost_1_1_d_c_c_p_socket.html">DCCPSocket</a> &server, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a server session by accepting a DCCP <a class="el" href="classost_1_1_socket.html" title="The Socket is used as the base for all Internet protocol services under Common C++...">Socket</a>. <a href="#a482efc81f69bb1714246961e9428f355"></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_1_d_c_c_p_socket.html#a1ae2f13c0ece05744a984f3f63ff15ea">reject</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to reject the next incoming connection request. <a href="#a1ae2f13c0ece05744a984f3f63ff15ea"></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_1_d_c_c_p_socket.html#a1e9564cbd59c0c0d4a0cc37c7a7e2386">disconnect</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disconnect active dccp connection (client use). <a href="#a1e9564cbd59c0c0d4a0cc37c7a7e2386"></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_d_c_c_p_socket.html#ace888e10d43d783e54a27c2b54bb52b5">setCCID</a> (<a class="el" href="config_8h.html#a2f658db822f8a23711b5bac1094c2185">uint8</a> ccid)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set CCID DCCP. <a href="#ace888e10d43d783e54a27c2b54bb52b5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_d_c_c_p_socket.html#a7b3493860e09060e9595ccd0c12ce9f3">getTxCCID</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get TX CCID DCCP. <a href="#a7b3493860e09060e9595ccd0c12ce9f3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_d_c_c_p_socket.html#a75afd18bac687e3c1dfdc75d099a6976">getRxCCID</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get RX CCID DCCP. <a href="#a75afd18bac687e3c1dfdc75d099a6976"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_d_c_c_p_socket.html#a7f4a7521e71e7a6a3969270c8e4e98b0">available</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return number of bytes to be read. <a href="#a7f4a7521e71e7a6a3969270c8e4e98b0"></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_1_d_c_c_p_socket.html#a4b635179424431431436fecf038bd02c">connect</a> (const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> &host, <a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a DCCP client connection to a DCCP socket (on a remote machine). <a href="#a4b635179424431431436fecf038bd02c"></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_1_d_c_c_p_socket.html#a1feb55845101d46c994829cfc41d0dd0">connect</a> (const <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> &host, <a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_d_c_c_p_socket.html#a5411e0d2df612a9d3778592306ec3d8e">connect</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connect to a named client. <a href="#a5411e0d2df612a9d3778592306ec3d8e"></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_d_c_c_p_socket.html#ad50bce35876eae7fc93ec408c397483d">isPendingConnection</a> (<a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=TIMEOUT_INF)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to wait for pending connection requests. <a href="#ad50bce35876eae7fc93ec408c397483d"></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_d_c_c_p_socket.html#a2655405d7fa06ef79db32e2ea44539c8">~DCCPSocket</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Use base socket handler for ending this socket. <a href="#a2655405d7fa06ef79db32e2ea44539c8"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>DCCP sockets are used for stream based connected sessions between two sockets. </p>
<p>Both error recovery and flow control operate transparently for a DCCP socket connection. The DCCP socket base class is used both for client connections and to bind a DCCP "server" for accepting DCCP streams.</p>
<p>An implicit and unique <a class="el" href="classost_1_1_d_c_c_p_socket.html" title="DCCP sockets are used for stream based connected sessions between two sockets.">DCCPSocket</a> object exists in Common C++ to represent a bound DCCP socket acting as a "server" for receiving connection requests. This class is not part of DCCPStream 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. The Common C++ <a class="el" href="classost_1_1_d_c_c_p_socket.html" title="DCCP sockets are used for stream based connected sessions between two sockets.">DCCPSocket</a> offers a Peek method to examine where the next pending connection is coming from, and a Reject method to flush the next request from the queue without having to create a session.</p>
<p>The <a class="el" href="classost_1_1_d_c_c_p_socket.html" title="DCCP sockets are used for stream based connected sessions between two sockets.">DCCPSocket</a> also supports a "OnAccept" method which can be called when a DCCPStream related object is created from a <a class="el" href="classost_1_1_d_c_c_p_socket.html" title="DCCP sockets are used for stream based connected sessions between two sockets.">DCCPSocket</a>. By creating a DCCPStream from a <a class="el" href="classost_1_1_d_c_c_p_socket.html" title="DCCP sockets are used for stream based connected sessions between two sockets.">DCCPSocket</a>, an accept operation automatically occurs, and the <a class="el" href="classost_1_1_d_c_c_p_socket.html" title="DCCP sockets are used for stream based connected sessions between two sockets.">DCCPSocket</a> can then still reject the client connection through the return status of it's OnAccept method.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>Leandro Sales <<a href="mailto:leandroal@gmail.com">leandroal@gmail.com</a>> </dd>
<dd>
Heverton Stuart <<a href="mailto:hevertonsns@gmail.com">hevertonsns@gmail.com</a>> bound server for DCCP streams and sessions. </dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa05194dc6aa07fa995f12b23f55717b7"></a><!-- doxytag: member="ost::DCCPSocket::DCCPSocket" ref="aa05194dc6aa07fa995f12b23f55717b7" args="(const IPV4Address &bind, tpport_t port, unsigned backlog=5)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::DCCPSocket::DCCPSocket </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> & </td>
<td class="paramname"> <em>bind</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="paramname"> <em>port</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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A DCCP "server" is created as a DCCP socket that is bound to a hardware address and port number on the local machine and that has a backlog queue to listen for remote 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>bind</em> </td><td>local ip address or interface to use. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>number to bind socket under. </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="af7f1b1a294d8b0d237930318248f0f83"></a><!-- doxytag: member="ost::DCCPSocket::DCCPSocket" ref="af7f1b1a294d8b0d237930318248f0f83" args="(const IPV6Address &bind, tpport_t port, unsigned backlog=5)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::DCCPSocket::DCCPSocket </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v6_address.html">IPV6Address</a> & </td>
<td class="paramname"> <em>bind</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="paramname"> <em>port</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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a6a05eda5d5acb23c17bed72f48fa04b0"></a><!-- doxytag: member="ost::DCCPSocket::DCCPSocket" ref="a6a05eda5d5acb23c17bed72f48fa04b0" args="(const char *name, Family family=IPV4, unsigned backlog=5)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::DCCPSocket::DCCPSocket </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">Family</a> </td>
<td class="paramname"> <em>family</em> = <code>IPV4</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </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>Create a named dccp socket by service and/or interface id. </p>
<p>For IPV4 we use [host:]svc or [host/]svc for the string. If we have getaddrinfo, we use that to obtain the addr to bind for.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of host interface and service port to bind. </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="ac2726df223429cd35f489bdaeb1c2c66"></a><!-- doxytag: member="ost::DCCPSocket::DCCPSocket" ref="ac2726df223429cd35f489bdaeb1c2c66" args="(Family family=IPV4)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::DCCPSocket::DCCPSocket </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">Family</a> </td>
<td class="paramname"> <em>family</em> = <code>IPV4</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an unconnected ephemeral DCCP client socket. </p>
</div>
</div>
<a class="anchor" id="a482efc81f69bb1714246961e9428f355"></a><!-- doxytag: member="ost::DCCPSocket::DCCPSocket" ref="a482efc81f69bb1714246961e9428f355" args="(DCCPSocket &server, timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::DCCPSocket::DCCPSocket </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_d_c_c_p_socket.html">DCCPSocket</a> & </td>
<td class="paramname"> <em>server</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>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 a server session by accepting a DCCP <a class="el" href="classost_1_1_socket.html" title="The Socket is used as the base for all Internet protocol services under Common C++...">Socket</a>. </p>
</div>
</div>
<a class="anchor" id="a2655405d7fa06ef79db32e2ea44539c8"></a><!-- doxytag: member="ost::DCCPSocket::~DCCPSocket" ref="a2655405d7fa06ef79db32e2ea44539c8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ost::DCCPSocket::~DCCPSocket </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="a7f4a7521e71e7a6a3969270c8e4e98b0"></a><!-- doxytag: member="ost::DCCPSocket::available" ref="a7f4a7521e71e7a6a3969270c8e4e98b0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t ost::DCCPSocket::available </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return number of bytes to be read. </p>
</div>
</div>
<a class="anchor" id="a5411e0d2df612a9d3778592306ec3d8e"></a><!-- doxytag: member="ost::DCCPSocket::connect" ref="a5411e0d2df612a9d3778592306ec3d8e" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::DCCPSocket::connect </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Connect to a named client. </p>
</div>
</div>
<a class="anchor" id="a1feb55845101d46c994829cfc41d0dd0"></a><!-- doxytag: member="ost::DCCPSocket::connect" ref="a1feb55845101d46c994829cfc41d0dd0" args="(const IPV6Host &host, tpport_t port, timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::DCCPSocket::connect </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> & </td>
<td class="paramname"> <em>host</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="paramname"> <em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a4b635179424431431436fecf038bd02c"></a><!-- doxytag: member="ost::DCCPSocket::connect" ref="a4b635179424431431436fecf038bd02c" args="(const IPV4Host &host, tpport_t port, timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::DCCPSocket::connect </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> & </td>
<td class="paramname"> <em>host</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="paramname"> <em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>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 a DCCP client connection to a DCCP socket (on a remote machine). </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>host</em> </td><td>address of remote DCCP server. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>number to connect. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1e9564cbd59c0c0d4a0cc37c7a7e2386"></a><!-- doxytag: member="ost::DCCPSocket::disconnect" ref="a1e9564cbd59c0c0d4a0cc37c7a7e2386" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::DCCPSocket::disconnect </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Disconnect active dccp connection (client use). </p>
</div>
</div>
<a class="anchor" id="a8121a7ac2a388a35ed30177d35361893"></a><!-- doxytag: member="ost::DCCPSocket::getIPV4Sender" ref="a8121a7ac2a388a35ed30177d35361893" args="(tpport_t *port=NULL) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> ost::DCCPSocket::getIPV4Sender </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="paramname"> <em>port</em> = <code>NULL</code></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classost_1_1_socket.html#a68a7acd6af1686e66e88e9e466a9903f">ost::Socket</a>.</p>
</div>
</div>
<a class="anchor" id="a5a3a4390c87849adb3119ad5c1210dd4"></a><!-- doxytag: member="ost::DCCPSocket::getIPV6Sender" ref="a5a3a4390c87849adb3119ad5c1210dd4" args="(tpport_t *port=NULL) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> ost::DCCPSocket::getIPV6Sender </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="paramname"> <em>port</em> = <code>NULL</code></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classost_1_1_socket.html#a4f1e7645a2d543e0a665b111c2dba8e9">ost::Socket</a>.</p>
</div>
</div>
<a class="anchor" id="a75afd18bac687e3c1dfdc75d099a6976"></a><!-- doxytag: member="ost::DCCPSocket::getRxCCID" ref="a75afd18bac687e3c1dfdc75d099a6976" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ost::DCCPSocket::getRxCCID </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get RX CCID DCCP. </p>
</div>
</div>
<a class="anchor" id="a7b3493860e09060e9595ccd0c12ce9f3"></a><!-- doxytag: member="ost::DCCPSocket::getTxCCID" ref="a7b3493860e09060e9595ccd0c12ce9f3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ost::DCCPSocket::getTxCCID </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get TX CCID DCCP. </p>
</div>
</div>
<a class="anchor" id="ad50bce35876eae7fc93ec408c397483d"></a><!-- doxytag: member="ost::DCCPSocket::isPendingConnection" ref="ad50bce35876eae7fc93ec408c397483d" args="(timeout_t timeout=TIMEOUT_INF)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::DCCPSocket::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>TIMEOUT_INF</code></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used to wait for pending connection requests. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if data packets available. </dd></dl>
<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>in milliseconds. TIMEOUT_INF if not specified. </td></tr>
</table>
</dd>
</dl>
<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>
<a class="anchor" id="a95a9441c6e7de26329950370b2f92343"></a><!-- doxytag: member="ost::DCCPSocket::onAccept" ref="a95a9441c6e7de26329950370b2f92343" args="(const IPV6Host &ia, tpport_t port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool ost::DCCPSocket::onAccept </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> & </td>
<td class="paramname"> <em>ia</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="paramname"> <em>port</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a93e7dcb9974093b34a24a955d18299c2"></a><!-- doxytag: member="ost::DCCPSocket::onAccept" ref="a93e7dcb9974093b34a24a955d18299c2" args="(const IPV4Host &ia, tpport_t port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool ost::DCCPSocket::onAccept </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> & </td>
<td class="paramname"> <em>ia</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="paramname"> <em>port</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A method to call in a derived <a class="el" href="classost_1_1_d_c_c_p_socket.html" title="DCCP sockets are used for stream based connected sessions between two sockets.">DCCPSocket</a> class that is acting as a server when a connection request is being accepted. </p>
<p>The server can implement protocol specific rules to exclude the remote socket from being accepted by returning false. The Peek method can also be used for this purpose.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if client should be accepted. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ia</em> </td><td>internet host address of the client. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>number of the client. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1ae2f13c0ece05744a984f3f63ff15ea"></a><!-- doxytag: member="ost::DCCPSocket::reject" ref="a1ae2f13c0ece05744a984f3f63ff15ea" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::DCCPSocket::reject </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used to reject the next incoming connection request. </p>
</div>
</div>
<a class="anchor" id="ace888e10d43d783e54a27c2b54bb52b5"></a><!-- doxytag: member="ost::DCCPSocket::setCCID" ref="ace888e10d43d783e54a27c2b54bb52b5" args="(uint8 ccid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::DCCPSocket::setCCID </td>
<td>(</td>
<td class="paramtype"><a class="el" href="config_8h.html#a2f658db822f8a23711b5bac1094c2185">uint8</a> </td>
<td class="paramname"> <em>ccid</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set CCID DCCP. </p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a9ac2cdf8619e553d36c2b400b41fb383"></a><!-- doxytag: member="ost::DCCPSocket::ipv4" ref="a9ac2cdf8619e553d36c2b400b41fb383" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct sockaddr_in <a class="el" href="classost_1_1_d_c_c_p_socket.html#a9ac2cdf8619e553d36c2b400b41fb383">ost::DCCPSocket::ipv4</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a09b8ad0a2d57808bcaa1f8e7022db4e6"></a><!-- doxytag: member="ost::DCCPSocket::ipv6" ref="a09b8ad0a2d57808bcaa1f8e7022db4e6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct sockaddr_in6 <a class="el" href="classost_1_1_d_c_c_p_socket.html#a09b8ad0a2d57808bcaa1f8e7022db4e6">ost::DCCPSocket::ipv6</a></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="socket_8h_source.html">socket.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:55:47 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
>
126
