<!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::UDPReceive 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_u_d_p_receive.html">UDPReceive</a></div>
<h1>ost::UDPReceive Class Reference</h1><!-- doxytag: class="ost::UDPReceive" --><!-- doxytag: inherits="ost::UDPSocket" -->Representing half of a two-way UDP connection, the UDP receiver can receive data from another peer host or subnet.Unreliable Datagram Peer Associations.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="socket_8h-source.html">socket.h</a>></code>
<p>
<p>Inheritance diagram for ost::UDPReceive:
<p><center><img src="classost_1_1_u_d_p_receive.png" usemap="#ost::UDPReceive_map" border="0" alt=""></center>
<map name="ost::UDPReceive_map">
<area href="classost_1_1_u_d_p_socket.html" alt="ost::UDPSocket" shape="rect" coords="0,56,105,80">
<area href="classost_1_1_socket.html" alt="ost::Socket" shape="rect" coords="0,0,105,24">
<area href="classost_1_1_u_d_p_duplex.html" alt="ost::UDPDuplex" shape="rect" coords="0,168,105,192">
</map>
<a href="classost_1_1_u_d_p_receive-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">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_receive.html#39f5e896422f2f3dda0948f265b8b013">receive</a> (void *buf, size_t len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a data packet from the connected peer host. <a href="#39f5e896422f2f3dda0948f265b8b013"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_receive.html#3a63f4aa241374a3550201eaf92c134a">isInputReady</a> (<a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=TIMEOUT_INF)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">See if input queue has data packets available. <a href="#3a63f4aa241374a3550201eaf92c134a"></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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_receive.html#8ad0a62539c428dc5674c550338025f5">UDPReceive</a> (const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> &bind, <a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a UDP receiver, bind it to a specific interface and port address so that other UDP sockets on remote machines (or the same host) may find and send UDP messages to it, and associate it with a given port on a peer host. <a href="#8ad0a62539c428dc5674c550338025f5"></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_u_d_p_receive.html#4dcbcf664f82a174e242754fa5ec9b8a">UDPReceive</a> (const <a class="el" href="classost_1_1_i_p_v6_address.html">IPV6Address</a> &bind, <a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_receive.html#a669c5dcf686c200752d4ca125f9f4a6">connect</a> (const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> &host, <a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Associate this socket with a specified peer host. <a href="#a669c5dcf686c200752d4ca125f9f4a6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_receive.html#0e8c851cbc68729353b76894107091e9">connect</a> (const <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> &host, <a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_receive.html#f5beaaf3d4941735b8784c1c1bc0ea99">isPendingReceive</a> (<a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check for pending data. <a href="#f5beaaf3d4941735b8784c1c1bc0ea99"></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_u_d_p_receive.html#ee5e39bfbba0ba9cbfb616b0df254bcd">endReceiver</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">End receiver. <a href="#ee5e39bfbba0ba9cbfb616b0df254bcd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="socket_8h.html#8dc8083897335125630f1af5dafd5831">SOCKET</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_receive.html#ab58fbd159ce6d8c3f539038196a0d11">getReceiver</a> (void) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_receive.html#e28ec2a16ac42d1a14f015ca5daa260f">setRouting</a> (bool enable)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_receive.html#a513f9513f012494e0fbd61d84c665f6">setMulticast</a> (bool enable)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_receive.html#29df9040b68e4e6b99a03827d7e112c8">join</a> (const <a class="el" href="classost_1_1_i_p_v4_multicast.html">IPV4Multicast</a> &ia)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_receive.html#3d1491c118a0609aa6f67aed9a7a5103">join</a> (const <a class="el" href="classost_1_1_i_p_v6_multicast.html">IPV6Multicast</a> &ia)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_receive.html#6ec872d42da02ac13e3390f4ec6cb98d">drop</a> (const <a class="el" href="classost_1_1_i_p_v4_multicast.html">IPV4Multicast</a> &ia)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_receive.html#4fb379f4df763e3726c8097d65d4c584">drop</a> (const <a class="el" href="classost_1_1_i_p_v6_multicast.html">IPV6Multicast</a> &ia)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Representing half of a two-way UDP connection, the UDP receiver can receive data from another peer host or subnet.Unreliable Datagram Peer Associations.
<p>
This class is used exclusivily to derive the <a class="el" href="classost_1_1_u_d_p_duplex.html">UDPDuplex</a>.<p>
<dl compact><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> </dd></dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="8ad0a62539c428dc5674c550338025f5"></a><!-- doxytag: member="ost::UDPReceive::UDPReceive" ref="8ad0a62539c428dc5674c550338025f5" args="(const IPV4Address &bind, tpport_t port)" --><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::UDPReceive::UDPReceive </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> & </td>
<td class="mdname" nowrap> <em>bind</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="mdname" nowrap> <em>port</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create a UDP receiver, bind it to a specific interface and port address so that other UDP sockets on remote machines (or the same host) may find and send UDP messages to it, and associate it with a given port on a peer host.
<p>
On failure to bind, an exception is thrown.<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>bind</em> </td><td>address to bind this socket to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>number to bind this socket to. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="4dcbcf664f82a174e242754fa5ec9b8a"></a><!-- doxytag: member="ost::UDPReceive::UDPReceive" ref="4dcbcf664f82a174e242754fa5ec9b8a" args="(const IPV6Address &bind, tpport_t port)" --><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::UDPReceive::UDPReceive </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v6_address.html">IPV6Address</a> & </td>
<td class="mdname" nowrap> <em>bind</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="mdname" nowrap> <em>port</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0e8c851cbc68729353b76894107091e9"></a><!-- doxytag: member="ost::UDPReceive::connect" ref="0e8c851cbc68729353b76894107091e9" args="(const IPV6Host &host, tpport_t port)" --><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"><a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> ost::UDPReceive::connect </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> & </td>
<td class="mdname" nowrap> <em>host</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="mdname" nowrap> <em>port</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<p>
Reimplemented from <a class="el" href="classost_1_1_u_d_p_socket.html#759c8f5c76cacfdeac979a5034d658d7">ost::UDPSocket</a>.
<p>
Reimplemented in <a class="el" href="classost_1_1_u_d_p_duplex.html#60abbfd8ef6eac65c8b9726a1d489440">ost::UDPDuplex</a>. </td>
</tr>
</table>
<a class="anchor" name="a669c5dcf686c200752d4ca125f9f4a6"></a><!-- doxytag: member="ost::UDPReceive::connect" ref="a669c5dcf686c200752d4ca125f9f4a6" args="(const IPV4Host &host, tpport_t port)" --><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"><a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> ost::UDPReceive::connect </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> & </td>
<td class="mdname" nowrap> <em>host</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="mdname" nowrap> <em>port</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Associate this socket with a specified peer host.
<p>
The port number from the constructor will be used. All UDP packets will be sent received from the specified host.<p>
<dl compact><dt><b>Returns:</b></dt><dd>0 on success, -1 on error. </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>host</em> </td><td>host network address to connect socket to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>host transport port to connect socket to. </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classost_1_1_u_d_p_socket.html#519db2909a1c43e791e6620b758d3fdc">ost::UDPSocket</a>.
<p>
Reimplemented in <a class="el" href="classost_1_1_u_d_p_duplex.html#219b6497a5dd25e943639cfc1bbb8f81">ost::UDPDuplex</a>. </td>
</tr>
</table>
<a class="anchor" name="4fb379f4df763e3726c8097d65d4c584"></a><!-- doxytag: member="ost::UDPReceive::drop" ref="4fb379f4df763e3726c8097d65d4c584" args="(const IPV6Multicast &ia)" --><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"><a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> ost::UDPReceive::drop </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v6_multicast.html">IPV6Multicast</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>ia</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<p>
Reimplemented from <a class="el" href="classost_1_1_socket.html#54bb968bfe110dc65bd5d0fb4a47383d">ost::Socket</a>. </td>
</tr>
</table>
<a class="anchor" name="6ec872d42da02ac13e3390f4ec6cb98d"></a><!-- doxytag: member="ost::UDPReceive::drop" ref="6ec872d42da02ac13e3390f4ec6cb98d" args="(const IPV4Multicast &ia)" --><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"><a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> ost::UDPReceive::drop </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v4_multicast.html">IPV4Multicast</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>ia</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<p>
Reimplemented from <a class="el" href="classost_1_1_socket.html#c59c08e11070a1602352da5c54332d9e">ost::Socket</a>. </td>
</tr>
</table>
<a class="anchor" name="ee5e39bfbba0ba9cbfb616b0df254bcd"></a><!-- doxytag: member="ost::UDPReceive::endReceiver" ref="ee5e39bfbba0ba9cbfb616b0df254bcd" 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::UDPReceive::endReceiver </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> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
End receiver.
<p>
</td>
</tr>
</table>
<a class="anchor" name="ab58fbd159ce6d8c3f539038196a0d11"></a><!-- doxytag: member="ost::UDPReceive::getReceiver" ref="ab58fbd159ce6d8c3f539038196a0d11" args="(void) const " --><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"><a class="el" href="socket_8h.html#8dc8083897335125630f1af5dafd5831">SOCKET</a> ost::UDPReceive::getReceiver </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> const<code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="3a63f4aa241374a3550201eaf92c134a"></a><!-- doxytag: member="ost::UDPReceive::isInputReady" ref="3a63f4aa241374a3550201eaf92c134a" 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">bool ost::UDPReceive::isInputReady </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> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
See if input queue has data packets available.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>true if data packets available. </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>in milliseconds. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="f5beaaf3d4941735b8784c1c1bc0ea99"></a><!-- doxytag: member="ost::UDPReceive::isPendingReceive" ref="f5beaaf3d4941735b8784c1c1bc0ea99" args="(timeout_t timeout)" --><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">bool ost::UDPReceive::isPendingReceive </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> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Check for pending data.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>true if data is waiting. </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>in milliseconds. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="3d1491c118a0609aa6f67aed9a7a5103"></a><!-- doxytag: member="ost::UDPReceive::join" ref="3d1491c118a0609aa6f67aed9a7a5103" args="(const IPV6Multicast &ia)" --><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"><a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> ost::UDPReceive::join </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v6_multicast.html">IPV6Multicast</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>ia</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<p>
Reimplemented from <a class="el" href="classost_1_1_socket.html#b7d4e7cfd0411833ab0b02db1dbed8d5">ost::Socket</a>. </td>
</tr>
</table>
<a class="anchor" name="29df9040b68e4e6b99a03827d7e112c8"></a><!-- doxytag: member="ost::UDPReceive::join" ref="29df9040b68e4e6b99a03827d7e112c8" args="(const IPV4Multicast &ia)" --><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"><a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> ost::UDPReceive::join </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v4_multicast.html">IPV4Multicast</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>ia</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<p>
Reimplemented from <a class="el" href="classost_1_1_socket.html#fb0e2d234f461ce45711bff52ffc96ad">ost::Socket</a>. </td>
</tr>
</table>
<a class="anchor" name="39f5e896422f2f3dda0948f265b8b013"></a><!-- doxytag: member="ost::UDPReceive::receive" ref="39f5e896422f2f3dda0948f265b8b013" args="(void *buf, size_t len)" --><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">ssize_t ost::UDPReceive::receive </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void * </td>
<td class="mdname" nowrap> <em>buf</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>size_t </td>
<td class="mdname" nowrap> <em>len</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Receive a data packet from the connected peer host.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>num of bytes actually received. </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>buf</em> </td><td>address of data receive buffer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>size of data receive buffer. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a513f9513f012494e0fbd61d84c665f6"></a><!-- doxytag: member="ost::UDPReceive::setMulticast" ref="a513f9513f012494e0fbd61d84c665f6" args="(bool enable)" --><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"><a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> ost::UDPReceive::setMulticast </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>enable</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<p>
Reimplemented from <a class="el" href="classost_1_1_u_d_p_socket.html#ce98f5833ad9834af24e78697699c912">ost::UDPSocket</a>. </td>
</tr>
</table>
<a class="anchor" name="e28ec2a16ac42d1a14f015ca5daa260f"></a><!-- doxytag: member="ost::UDPReceive::setRouting" ref="e28ec2a16ac42d1a14f015ca5daa260f" args="(bool enable)" --><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"><a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> ost::UDPReceive::setRouting </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>enable</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<p>
Reimplemented from <a class="el" href="classost_1_1_socket.html#2165fdf85e39e6a8aaff3da889ae7e20">ost::Socket</a>. </td>
</tr>
</table>
<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></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:57 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>
