<!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::UDPReceive 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_u_d_p_receive.html">UDPReceive</a>
</div>
</div>
<div class="contents">
<h1>ost::UDPReceive Class Reference</h1><!-- doxytag: class="ost::UDPReceive" --><!-- doxytag: inherits="ost::UDPSocket" -->
<p>Representing half of a two-way UDP connection, the UDP receiver can receive data from another peer host or subnet.
<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::UDPReceive:</div>
<div class="dynsection">
<div class="center">
<img src="classost_1_1_u_d_p_receive.png" usemap="#ost::UDPReceive_map" alt=""/>
<map id="ost::UDPReceive_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>
</div>
</div>
<p><a href="classost_1_1_u_d_p_receive-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">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_receive.html#a39f5e896422f2f3dda0948f265b8b013">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="#a39f5e896422f2f3dda0948f265b8b013"></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_u_d_p_receive.html#a3a63f4aa241374a3550201eaf92c134a">isInputReady</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">See if input queue has data packets available. <a href="#a3a63f4aa241374a3550201eaf92c134a"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected 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_u_d_p_receive.html#a8ad0a62539c428dc5674c550338025f5">UDPReceive</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)</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="#a8ad0a62539c428dc5674c550338025f5"></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_u_d_p_receive.html#a4dcbcf664f82a174e242754fa5ec9b8a">UDPReceive</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)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_receive.html#aa669c5dcf686c200752d4ca125f9f4a6">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)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Associate this socket with a specified peer host. <a href="#aa669c5dcf686c200752d4ca125f9f4a6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_receive.html#a0e8c851cbc68729353b76894107091e9">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)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_receive.html#af5beaaf3d4941735b8784c1c1bc0ea99">isPendingReceive</a> (<a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check for pending data. <a href="#af5beaaf3d4941735b8784c1c1bc0ea99"></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_u_d_p_receive.html#aee5e39bfbba0ba9cbfb616b0df254bcd">endReceiver</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">End receiver. <a href="#aee5e39bfbba0ba9cbfb616b0df254bcd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="socket_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_receive.html#aab58fbd159ce6d8c3f539038196a0d11">getReceiver</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_receive.html#ae28ec2a16ac42d1a14f015ca5daa260f">setRouting</a> (bool enable)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_receive.html#aa513f9513f012494e0fbd61d84c665f6">setMulticast</a> (bool enable)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_receive.html#a29df9040b68e4e6b99a03827d7e112c8">join</a> (const <a class="el" href="classost_1_1_i_p_v4_multicast.html">IPV4Multicast</a> &ia)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_receive.html#a3d1491c118a0609aa6f67aed9a7a5103">join</a> (const <a class="el" href="classost_1_1_i_p_v6_multicast.html">IPV6Multicast</a> &ia)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_receive.html#a6ec872d42da02ac13e3390f4ec6cb98d">drop</a> (const <a class="el" href="classost_1_1_i_p_v4_multicast.html">IPV4Multicast</a> &ia)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_receive.html#a4fb379f4df763e3726c8097d65d4c584">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>
<p>Representing half of a two-way UDP connection, the UDP receiver can receive data from another peer host or subnet. </p>
<p>This class is used exclusivily to derive the <a class="el" href="classost_1_1_u_d_p_duplex.html" title="UDP duplex connections impliment a bi-directional point-to-point UDP session between...">UDPDuplex</a>.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> Unreliable Datagram Peer Associations. </dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8ad0a62539c428dc5674c550338025f5"></a><!-- doxytag: member="ost::UDPReceive::UDPReceive" ref="a8ad0a62539c428dc5674c550338025f5" args="(const IPV4Address &bind, tpport_t port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::UDPReceive::UDPReceive </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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
<p>On failure to bind, 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>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>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4dcbcf664f82a174e242754fa5ec9b8a"></a><!-- doxytag: member="ost::UDPReceive::UDPReceive" ref="a4dcbcf664f82a174e242754fa5ec9b8a" args="(const IPV6Address &bind, tpport_t port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::UDPReceive::UDPReceive </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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0e8c851cbc68729353b76894107091e9"></a><!-- doxytag: member="ost::UDPReceive::connect" ref="a0e8c851cbc68729353b76894107091e9" args="(const IPV6Host &host, tpport_t port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::UDPReceive::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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classost_1_1_u_d_p_socket.html#a759c8f5c76cacfdeac979a5034d658d7">ost::UDPSocket</a>.</p>
<p>Reimplemented in <a class="el" href="classost_1_1_u_d_p_duplex.html#a60abbfd8ef6eac65c8b9726a1d489440">ost::UDPDuplex</a>.</p>
</div>
</div>
<a class="anchor" id="aa669c5dcf686c200752d4ca125f9f4a6"></a><!-- doxytag: member="ost::UDPReceive::connect" ref="aa669c5dcf686c200752d4ca125f9f4a6" args="(const IPV4Host &host, tpport_t port)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::UDPReceive::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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Associate this socket with a specified peer host. </p>
<p>The port number from the constructor will be used. All UDP packets will be sent received from the specified host.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, -1 on error. </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>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>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classost_1_1_u_d_p_socket.html#a519db2909a1c43e791e6620b758d3fdc">ost::UDPSocket</a>.</p>
<p>Reimplemented in <a class="el" href="classost_1_1_u_d_p_duplex.html#a219b6497a5dd25e943639cfc1bbb8f81">ost::UDPDuplex</a>.</p>
</div>
</div>
<a class="anchor" id="a4fb379f4df763e3726c8097d65d4c584"></a><!-- doxytag: member="ost::UDPReceive::drop" ref="a4fb379f4df763e3726c8097d65d4c584" args="(const IPV6Multicast &ia)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::UDPReceive::drop </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v6_multicast.html">IPV6Multicast</a> & </td>
<td class="paramname"> <em>ia</em></td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classost_1_1_socket.html#a54bb968bfe110dc65bd5d0fb4a47383d">ost::Socket</a>.</p>
<p>References <a class="el" href="classost_1_1_socket.html#ac59c08e11070a1602352da5c54332d9e">ost::Socket::drop()</a>.</p>
</div>
</div>
<a class="anchor" id="a6ec872d42da02ac13e3390f4ec6cb98d"></a><!-- doxytag: member="ost::UDPReceive::drop" ref="a6ec872d42da02ac13e3390f4ec6cb98d" args="(const IPV4Multicast &ia)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::UDPReceive::drop </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_multicast.html">IPV4Multicast</a> & </td>
<td class="paramname"> <em>ia</em></td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classost_1_1_socket.html#ac59c08e11070a1602352da5c54332d9e">ost::Socket</a>.</p>
<p>References <a class="el" href="classost_1_1_socket.html#ac59c08e11070a1602352da5c54332d9e">ost::Socket::drop()</a>.</p>
</div>
</div>
<a class="anchor" id="aee5e39bfbba0ba9cbfb616b0df254bcd"></a><!-- doxytag: member="ost::UDPReceive::endReceiver" ref="aee5e39bfbba0ba9cbfb616b0df254bcd" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::UDPReceive::endReceiver </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>End receiver. </p>
<p>References <a class="el" href="classost_1_1_socket.html#a3ab340e773f0214eefcf66f588bcf174">ost::Socket::endSocket()</a>.</p>
</div>
</div>
<a class="anchor" id="aab58fbd159ce6d8c3f539038196a0d11"></a><!-- doxytag: member="ost::UDPReceive::getReceiver" ref="aab58fbd159ce6d8c3f539038196a0d11" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="socket_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a> ost::UDPReceive::getReceiver </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a3a63f4aa241374a3550201eaf92c134a"></a><!-- doxytag: member="ost::UDPReceive::isInputReady" ref="a3a63f4aa241374a3550201eaf92c134a" args="(timeout_t timeout=TIMEOUT_INF)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::UDPReceive::isInputReady </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>See if input queue has data packets available. </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. </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="af5beaaf3d4941735b8784c1c1bc0ea99"></a><!-- doxytag: member="ost::UDPReceive::isPendingReceive" ref="af5beaaf3d4941735b8784c1c1bc0ea99" args="(timeout_t timeout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::UDPReceive::isPendingReceive </td>
<td>(</td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timeout</em></td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check for pending data. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if data is waiting. </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. </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="a3d1491c118a0609aa6f67aed9a7a5103"></a><!-- doxytag: member="ost::UDPReceive::join" ref="a3d1491c118a0609aa6f67aed9a7a5103" args="(const IPV6Multicast &ia)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::UDPReceive::join </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v6_multicast.html">IPV6Multicast</a> & </td>
<td class="paramname"> <em>ia</em></td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classost_1_1_socket.html#ab7d4e7cfd0411833ab0b02db1dbed8d5">ost::Socket</a>.</p>
<p>References <a class="el" href="classost_1_1_socket.html#afb0e2d234f461ce45711bff52ffc96ad">ost::Socket::join()</a>.</p>
</div>
</div>
<a class="anchor" id="a29df9040b68e4e6b99a03827d7e112c8"></a><!-- doxytag: member="ost::UDPReceive::join" ref="a29df9040b68e4e6b99a03827d7e112c8" args="(const IPV4Multicast &ia)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::UDPReceive::join </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_multicast.html">IPV4Multicast</a> & </td>
<td class="paramname"> <em>ia</em></td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classost_1_1_socket.html#afb0e2d234f461ce45711bff52ffc96ad">ost::Socket</a>.</p>
<p>References <a class="el" href="classost_1_1_socket.html#afb0e2d234f461ce45711bff52ffc96ad">ost::Socket::join()</a>.</p>
</div>
</div>
<a class="anchor" id="a39f5e896422f2f3dda0948f265b8b013"></a><!-- doxytag: member="ost::UDPReceive::receive" ref="a39f5e896422f2f3dda0948f265b8b013" args="(void *buf, size_t len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t ost::UDPReceive::receive </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>len</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Receive a data packet from the connected peer host. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>num of bytes actually received. </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>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>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa513f9513f012494e0fbd61d84c665f6"></a><!-- doxytag: member="ost::UDPReceive::setMulticast" ref="aa513f9513f012494e0fbd61d84c665f6" args="(bool enable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::UDPReceive::setMulticast </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>enable</em></td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classost_1_1_u_d_p_socket.html#ace98f5833ad9834af24e78697699c912">ost::UDPSocket</a>.</p>
<p>References <a class="el" href="classost_1_1_socket.html#a09b396c3fc7316061a3f0539e918a43f">ost::Socket::setMulticastByFamily()</a>.</p>
</div>
</div>
<a class="anchor" id="ae28ec2a16ac42d1a14f015ca5daa260f"></a><!-- doxytag: member="ost::UDPReceive::setRouting" ref="ae28ec2a16ac42d1a14f015ca5daa260f" args="(bool enable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::UDPReceive::setRouting </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>enable</em></td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classost_1_1_socket.html#a2165fdf85e39e6a8aaff3da889ae7e20">ost::Socket</a>.</p>
<p>References <a class="el" href="classost_1_1_socket.html#a2165fdf85e39e6a8aaff3da889ae7e20">ost::Socket::setRouting()</a>.</p>
</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 Mar 12 10:07:41 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>
