<!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::UDPTransmit 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_transmit.html">UDPTransmit</a>
</div>
</div>
<div class="contents">
<h1>ost::UDPTransmit Class Reference</h1><!-- doxytag: class="ost::UDPTransmit" --><!-- doxytag: inherits="ost::UDPSocket" -->
<p>Representing half of a two-way UDP connection, the UDP transmitter can broadcast data to another selected peer host or to an entire 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::UDPTransmit:</div>
<div class="dynsection">
<div class="center">
<img src="classost_1_1_u_d_p_transmit.png" usemap="#ost::UDPTransmit_map" alt=""/>
<map id="ost::UDPTransmit_map" name="ost::UDPTransmit_map">
<area href="classost_1_1_u_d_p_socket.html" alt="ost::UDPSocket" shape="rect" coords="0,56,106,80"/>
<area href="classost_1_1_socket.html" alt="ost::Socket" shape="rect" coords="0,0,106,24"/>
<area href="classost_1_1_u_d_p_duplex.html" alt="ost::UDPDuplex" shape="rect" coords="0,168,106,192"/>
</map>
</div>
</div>
<p><a href="classost_1_1_u_d_p_transmit-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_transmit.html#ab648dd889101cf98bcad682299c48329">transmit</a> (const char *buffer, size_t len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Transmit "send" to use "connected" send rather than sendto. <a href="#ab648dd889101cf98bcad682299c48329"></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_transmit.html#addc1e1aff22446589d633bacfc436e38">isOutputReady</a> (unsigned long timeout=0l)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">See if output queue is empty for sending more packets. <a href="#addc1e1aff22446589d633bacfc436e38"></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_transmit.html#a04ebd34e6cfc70146bfe3789c31d8903">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_transmit.html#a11c5788901bb8c18af8428efe9c54145">setTypeOfService</a> (<a class="el" href="classost_1_1_socket.html#a258f81f5a42d051242f0f49f8192f890">Tos</a> tos)</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_transmit.html#a86e9e41d05629a5e6f3029ace0d55e38">setBroadcast</a> (bool enable)</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_transmit.html#abcc795e183ac0946e15ebbbfcccc02b8">UDPTransmit</a> (<a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">Family</a> <a class="el" href="classost_1_1_u_d_p_socket.html#afe9f40091dc6c57c6743cf0720ab5938">family</a>=IPV4)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a UDP transmitter. <a href="#abcc795e183ac0946e15ebbbfcccc02b8"></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_transmit.html#a3946f1bdd89bc7ea15bd12b334ea7731">UDPTransmit</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=5005)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a UDP transmitter, 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="#a3946f1bdd89bc7ea15bd12b334ea7731"></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_transmit.html#a7a885da253f8e71d147368bd55100e35">UDPTransmit</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=5005)</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_transmit.html#ad9b9d46dfaf10ad1555c0fa08db339be">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="#ad9b9d46dfaf10ad1555c0fa08db339be"></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_transmit.html#a3e980aa2cad3bd07ff563900d03496a6">connect</a> (const <a class="el" href="classost_1_1_i_p_v6_address.html">IPV6Address</a> &host, <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_transmit.html#ad9ca909bb537be5b010a0aac902835c1">connect</a> (const <a class="el" href="classost_1_1_i_p_v4_broadcast.html">IPV4Broadcast</a> &subnet, <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 subnet of peer hosts for subnet broadcasting. <a href="#ad9ca909bb537be5b010a0aac902835c1"></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_transmit.html#a5e2f1e49a282bbdd4a852cf807be5022">connect</a> (const <a class="el" href="classost_1_1_i_p_v4_multicast.html">IPV4Multicast</a> &mgroup, <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 multicast group. <a href="#a5e2f1e49a282bbdd4a852cf807be5022"></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_transmit.html#a34494a97d3d5e68bc0cf02c9bad5d810">connect</a> (const <a class="el" href="classost_1_1_i_p_v6_multicast.html">IPV6Multicast</a> &mgroup, <a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port)</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_transmit.html#ac20e40569ec5502849fa3337dcfdf611">send</a> (const void *buf, size_t len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Transmit "send" to use "connected" send rather than sendto. <a href="#ac20e40569ec5502849fa3337dcfdf611"></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_transmit.html#afda647033eb798b91e2c2ef3b089c5b2">endTransmitter</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop transmitter. <a href="#afda647033eb798b91e2c2ef3b089c5b2"></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_transmit.html#a69b7f01eb52ae82bf91f2eefc0854918">getTransmitter</a> (void)</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_transmit.html#a4e5c8fb7c2ea5f78454d303169d68b61">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_transmit.html#a80800a55f609d62bbd8d7635f4798e6d">setTimeToLive</a> (unsigned char <a class="el" href="classost_1_1_socket.html#a6adc7a5d594ab3b8bace496f7a6757e9">ttl</a>)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Representing half of a two-way UDP connection, the UDP transmitter can broadcast data to another selected peer host or to an entire subnet. </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="abcc795e183ac0946e15ebbbfcccc02b8"></a><!-- doxytag: member="ost::UDPTransmit::UDPTransmit" ref="abcc795e183ac0946e15ebbbfcccc02b8" args="(Family family=IPV4)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::UDPTransmit::UDPTransmit </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><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a UDP transmitter. </p>
</div>
</div>
<a class="anchor" id="a3946f1bdd89bc7ea15bd12b334ea7731"></a><!-- doxytag: member="ost::UDPTransmit::UDPTransmit" ref="a3946f1bdd89bc7ea15bd12b334ea7731" args="(const IPV4Address &bind, tpport_t port=5005)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::UDPTransmit::UDPTransmit </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> = <code>5005</code></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 transmitter, 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. This class is only used to build the UDP Duplex.</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="a7a885da253f8e71d147368bd55100e35"></a><!-- doxytag: member="ost::UDPTransmit::UDPTransmit" ref="a7a885da253f8e71d147368bd55100e35" args="(const IPV6Address &bind, tpport_t port=5005)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::UDPTransmit::UDPTransmit </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> = <code>5005</code></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="a34494a97d3d5e68bc0cf02c9bad5d810"></a><!-- doxytag: member="ost::UDPTransmit::connect" ref="a34494a97d3d5e68bc0cf02c9bad5d810" args="(const IPV6Multicast &mgroup, 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::UDPTransmit::connect </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>mgroup</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>
<a class="anchor" id="a5e2f1e49a282bbdd4a852cf807be5022"></a><!-- doxytag: member="ost::UDPTransmit::connect" ref="a5e2f1e49a282bbdd4a852cf807be5022" args="(const IPV4Multicast &mgroup, 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::UDPTransmit::connect </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>mgroup</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 multicast group. </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>mgroup</em> </td><td>address of the multicast group to send to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>port number </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad9ca909bb537be5b010a0aac902835c1"></a><!-- doxytag: member="ost::UDPTransmit::connect" ref="ad9ca909bb537be5b010a0aac902835c1" args="(const IPV4Broadcast &subnet, 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::UDPTransmit::connect </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_broadcast.html">IPV4Broadcast</a> & </td>
<td class="paramname"> <em>subnet</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 subnet of peer hosts for subnet broadcasting. </p>
<p>The server must be able to assert broadcast permission for the socket.</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>subnet</em> </td><td>subnet address to broadcast into. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>transport port to broadcast into. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3e980aa2cad3bd07ff563900d03496a6"></a><!-- doxytag: member="ost::UDPTransmit::connect" ref="a3e980aa2cad3bd07ff563900d03496a6" args="(const IPV6Address &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::UDPTransmit::connect </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>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">
</div>
</div>
<a class="anchor" id="ad9b9d46dfaf10ad1555c0fa08db339be"></a><!-- doxytag: member="ost::UDPTransmit::connect" ref="ad9b9d46dfaf10ad1555c0fa08db339be" 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::UDPTransmit::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 to and 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>address to connect socket to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>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="afda647033eb798b91e2c2ef3b089c5b2"></a><!-- doxytag: member="ost::UDPTransmit::endTransmitter" ref="afda647033eb798b91e2c2ef3b089c5b2" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::UDPTransmit::endTransmitter </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>Stop transmitter. </p>
<p>References <a class="el" href="classost_1_1_socket.html#a3ab340e773f0214eefcf66f588bcf174">ost::Socket::endSocket()</a>.</p>
</div>
</div>
<a class="anchor" id="a69b7f01eb52ae82bf91f2eefc0854918"></a><!-- doxytag: member="ost::UDPTransmit::getTransmitter" ref="a69b7f01eb52ae82bf91f2eefc0854918" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="socket_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a> ost::UDPTransmit::getTransmitter </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">
</div>
</div>
<a class="anchor" id="addc1e1aff22446589d633bacfc436e38"></a><!-- doxytag: member="ost::UDPTransmit::isOutputReady" ref="addc1e1aff22446589d633bacfc436e38" args="(unsigned long timeout=0l)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::UDPTransmit::isOutputReady </td>
<td>(</td>
<td class="paramtype">unsigned long </td>
<td class="paramname"> <em>timeout</em> = <code>0l</code></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See if output queue is empty for sending more packets. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if output 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 to wait. </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#l00176">ost::Socket::pendingOutput</a>.</p>
</div>
</div>
<a class="anchor" id="ac20e40569ec5502849fa3337dcfdf611"></a><!-- doxytag: member="ost::UDPTransmit::send" ref="ac20e40569ec5502849fa3337dcfdf611" args="(const void *buf, size_t len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t ost::UDPTransmit::send </td>
<td>(</td>
<td class="paramtype">const 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, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Transmit "send" to use "connected" send rather than sendto. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of bytes sent. </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 buffer to send. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>of bytes to send. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classost_1_1_u_d_p_socket.html#a4d58bb8e7a0ea0112da563bfd2eaa947">ost::UDPSocket</a>.</p>
<p>References <a class="el" href="socket_8h_source.html#l00076">MSG_NOSIGNAL</a>.</p>
</div>
</div>
<a class="anchor" id="a86e9e41d05629a5e6f3029ace0d55e38"></a><!-- doxytag: member="ost::UDPTransmit::setBroadcast" ref="a86e9e41d05629a5e6f3029ace0d55e38" 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::UDPTransmit::setBroadcast </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>enable</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classost_1_1_socket.html#a1a507041ee5741bcdc906707b1735781">ost::Socket</a>.</p>
<p>References <a class="el" href="classost_1_1_socket.html#a1a507041ee5741bcdc906707b1735781">ost::Socket::setBroadcast()</a>.</p>
</div>
</div>
<a class="anchor" id="a4e5c8fb7c2ea5f78454d303169d68b61"></a><!-- doxytag: member="ost::UDPTransmit::setMulticast" ref="a4e5c8fb7c2ea5f78454d303169d68b61" 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::UDPTransmit::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="a04ebd34e6cfc70146bfe3789c31d8903"></a><!-- doxytag: member="ost::UDPTransmit::setRouting" ref="a04ebd34e6cfc70146bfe3789c31d8903" 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::UDPTransmit::setRouting </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>enable</em></td>
<td> ) </td>
<td><code> [inline]</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>
<a class="anchor" id="a80800a55f609d62bbd8d7635f4798e6d"></a><!-- doxytag: member="ost::UDPTransmit::setTimeToLive" ref="a80800a55f609d62bbd8d7635f4798e6d" args="(unsigned char ttl)" -->
<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::UDPTransmit::setTimeToLive </td>
<td>(</td>
<td class="paramtype">unsigned char </td>
<td class="paramname"> <em>ttl</em></td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>References <a class="el" href="classost_1_1_socket.html#a23d69227150ae996caf76b01024c1b20">ost::Socket::setTimeToLiveByFamily()</a>.</p>
</div>
</div>
<a class="anchor" id="a11c5788901bb8c18af8428efe9c54145"></a><!-- doxytag: member="ost::UDPTransmit::setTypeOfService" ref="a11c5788901bb8c18af8428efe9c54145" args="(Tos tos)" -->
<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::UDPTransmit::setTypeOfService </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_socket.html#a258f81f5a42d051242f0f49f8192f890">Tos</a> </td>
<td class="paramname"> <em>tos</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classost_1_1_socket.html#ae49df7e3c3913147116d8491f77a1b63">ost::Socket</a>.</p>
<p>References <a class="el" href="classost_1_1_socket.html#ae49df7e3c3913147116d8491f77a1b63">ost::Socket::setTypeOfService()</a>.</p>
</div>
</div>
<a class="anchor" id="ab648dd889101cf98bcad682299c48329"></a><!-- doxytag: member="ost::UDPTransmit::transmit" ref="ab648dd889101cf98bcad682299c48329" args="(const char *buffer, size_t len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t ost::UDPTransmit::transmit </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>buffer</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>Transmit "send" to use "connected" send rather than sendto. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>Windows does not support MSG_DONTWAIT, so it is defined as 0 on that platform. </dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of bytes sent. </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>buffer</em> </td><td>address of buffer to send. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>of bytes to send. </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="socket_8h_source.html#l00076">MSG_NOSIGNAL</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 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
>
427
