<!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::UDPSocket 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_socket.html">UDPSocket</a> </div> </div> <div class="contents"> <h1>ost::UDPSocket Class Reference</h1><!-- doxytag: class="ost::UDPSocket" --><!-- doxytag: inherits="ost::Socket" --> <p>UDP sockets implement the TCP SOCK_DGRAM UDP protocol. <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::UDPSocket:</div> <div class="dynsection"> <div class="center"> <img src="classost_1_1_u_d_p_socket.png" usemap="#ost::UDPSocket_map" alt=""/> <map id="ost::UDPSocket_map" name="ost::UDPSocket_map"> <area href="classost_1_1_socket.html" alt="ost::Socket" shape="rect" coords="126,0,242,24"/> <area href="classost_1_1_u_d_p_broadcast.html" alt="ost::UDPBroadcast" shape="rect" coords="0,112,116,136"/> <area href="classost_1_1_u_d_p_receive.html" alt="ost::UDPReceive" shape="rect" coords="126,112,242,136"/> <area href="classost_1_1_u_d_p_transmit.html" alt="ost::UDPTransmit" shape="rect" coords="252,112,368,136"/> <area href="classost_1_1_u_d_p_duplex.html" alt="ost::UDPDuplex" shape="rect" coords="126,168,242,192"/> <area href="classost_1_1_u_d_p_duplex.html" alt="ost::UDPDuplex" shape="rect" coords="252,168,368,192"/> </map> </div> </div> <p><a href="classost_1_1_u_d_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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_socket.html#a0171b5791de219c33e0bef1a7f01d366">UDPSocket</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 an unbound UDP socket, mostly for internal use. <a href="#a0171b5791de219c33e0bef1a7f01d366"></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_socket.html#a8f9e2a46cf3aaa4edf41cfb9ed402171">UDPSocket</a> (const char *name, <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 socket bound by a service name. <a href="#a8f9e2a46cf3aaa4edf41cfb9ed402171"></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_socket.html#a0e5c7aed7d7dbee9152282ca9d3627d2">UDPSocket</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 socket and 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. <a href="#a0e5c7aed7d7dbee9152282ca9d3627d2"></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_socket.html#a781894813be82c4f6aa5827fa087fb68">UDPSocket</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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_socket.html#a513c2f1fb2f84a295fe78527e47e052e">~UDPSocket</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a UDP socket as a socket. <a href="#a513c2f1fb2f84a295fe78527e47e052e"></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_socket.html#afbf86c658fcf48b0ba946a238df091d3">setLoopback</a> (bool enable)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the loopback. <a href="#afbf86c658fcf48b0ba946a238df091d3"></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_socket.html#ace98f5833ad9834af24e78697699c912">setMulticast</a> (bool enable)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the multicast. <a href="#ace98f5833ad9834af24e78697699c912"></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_socket.html#ad3cf52efd8d79b40796d67b59285d2cf">setTimeToLive</a> (char <a class="el" href="classost_1_1_socket.html#a6adc7a5d594ab3b8bace496f7a6757e9">ttl</a>)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set time to live. <a href="#ad3cf52efd8d79b40796d67b59285d2cf"></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_socket.html#a0a1aed4af396b54c42d5a616688b1426">setPeer</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">set the peer address to send message packets to. <a href="#a0a1aed4af396b54c42d5a616688b1426"></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_socket.html#a519db2909a1c43e791e6620b758d3fdc">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="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_socket.html#a943d73dd40035a5d675a9d4a7e102725">setPeer</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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_socket.html#a759c8f5c76cacfdeac979a5034d658d7">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"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Socket::Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_socket.html#aef52438ac3e537420d3264690a628dfa">getInterfaceIndex</a> (const char *ethX, int &InterfaceIndex)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">get the interface index for a named network device <a href="#aef52438ac3e537420d3264690a628dfa"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Socket::Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_socket.html#aa0277a5c4667f5c9e192c1dc5486b5fb">join</a> (const <a class="el" href="classost_1_1_i_p_v4_multicast.html">IPV4Multicast</a> &ia, int InterfaceIndex)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">join a multicast group on a particular interface <a href="#aa0277a5c4667f5c9e192c1dc5486b5fb"></a><br/></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_socket.html#a4d58bb8e7a0ea0112da563bfd2eaa947">send</a> (const void *buf, size_t len)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Send a message packet to a peer host. <a href="#a4d58bb8e7a0ea0112da563bfd2eaa947"></a><br/></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_socket.html#a3f5c684f2fc3d1b65a1a5e2966f5b292">receive</a> (void *buf, size_t len, bool reply=false)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a message from any host. <a href="#a3f5c684f2fc3d1b65a1a5e2966f5b292"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><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_u_d_p_socket.html#aa2d073bd4fa3c3f1c7b70629996c67f7">getIPV4Peer</a> (<a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Examine address of sender of next waiting packet. <a href="#aa2d073bd4fa3c3f1c7b70629996c67f7"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><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_u_d_p_socket.html#a5d06e7131790dd26cc3cf0b1531af3a2">getPeer</a> (<a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><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_u_d_p_socket.html#a37b34f874ffb96bfc933b4eda0f6e80c">getIPV6Peer</a> (<a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </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_socket.html#a64b09e6ac9325d8f44d7ca7ed59215bf">peek</a> (void *buf, size_t len)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Examine contents of next waiting packet. <a href="#a64b09e6ac9325d8f44d7ca7ed59215bf"></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_socket.html#a1bef3ed88eb3852679642510864b419c">setPeer</a> (const char *service)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Associate socket with a named connection. <a href="#a1bef3ed88eb3852679642510864b419c"></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_socket.html#a197a034e4ebc8172ede75d1d69616f15">connect</a> (const char *service)</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_socket.html#acb4faa86204e7b37bf447f4802c8940d">disconnect</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Disassociate this socket from any host connection. <a href="#acb4faa86204e7b37bf447f4802c8940d"></a><br/></td></tr> <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" >union {</td></tr> <tr><td class="memItemLeft" > struct sockaddr_in6 <a class="el" href="classost_1_1_u_d_p_socket.html#a9842db7ec82d337e554d264e7230a705">ipv6</a></td></tr> <tr><td class="memItemLeft" > struct sockaddr_in <a class="el" href="classost_1_1_u_d_p_socket.html#ad4c15c1eb5dd4f0ce6d4487b43869215">ipv4</a></td></tr> <tr><td class="memItemLeft" valign="top">} </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_socket.html#a124024a4168c6412b67490409a329820">peer</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">Family</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_u_d_p_socket.html#afe9f40091dc6c57c6743cf0720ab5938">family</a></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>UDP sockets implement the TCP SOCK_DGRAM UDP protocol. </p> <p>They can be used to pass unverified messages between hosts, or to broadcast a specific message to an entire subnet. Please note that Streaming of realtime data commonly use <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> related classes rather than <a class="el" href="classost_1_1_u_d_p_socket.html" title="UDP sockets implement the TCP SOCK_DGRAM UDP protocol.">UDPSocket</a>.</p> <p>In addition to connected TCP sessions, Common C++ supports UDP sockets and these also cover a range of functionality. Like a <a class="el" href="classost_1_1_t_c_p_socket.html" title="TCP sockets are used for stream based connected sessions between two sockets.">TCPSocket</a>, A <a class="el" href="classost_1_1_u_d_p_socket.html" title="UDP sockets implement the TCP SOCK_DGRAM UDP protocol.">UDPSocket</a> can be created bound to a specific network interface and/or port address, though this is not required. UDP sockets also are usually either connected or otherwise "associated" with a specific "peer" UDP socket. Since UDP sockets operate through discreet packets, there are no streaming operators used with UDP sockets.</p> <p>In addition to the UDP "socket" class, there is a "UDPBroadcast" class. The <a class="el" href="classost_1_1_u_d_p_broadcast.html" title="Representing a UDP socket used for subnet broadcasts, this class provides an alternate...">UDPBroadcast</a> is a socket that is set to send messages to a subnet as a whole rather than to an individual peer socket that it may be associated with.</p> <p>UDP sockets are often used for building "realtime" media streaming protocols and full duplex messaging services. When used in this manner, typically a pair of UDP sockets are used together; one socket is used to send and the other to receive data with an associated pair of UDP sockets on a "peer" host. This concept is represented through the Common C++ <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> object, which is a pair of sockets that communicate with another <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> pair.</p> <dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> Unreliable Datagram Protocol sockets. </dd></dl> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a0171b5791de219c33e0bef1a7f01d366"></a><!-- doxytag: member="ost::UDPSocket::UDPSocket" ref="a0171b5791de219c33e0bef1a7f01d366" args="(Family family=IPV4)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::UDPSocket::UDPSocket </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 unbound UDP socket, mostly for internal use. </p> </div> </div> <a class="anchor" id="a8f9e2a46cf3aaa4edf41cfb9ed402171"></a><!-- doxytag: member="ost::UDPSocket::UDPSocket" ref="a8f9e2a46cf3aaa4edf41cfb9ed402171" args="(const char *name, Family family=IPV4)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::UDPSocket::UDPSocket </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><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Create a UDP socket bound by a service name. </p> </div> </div> <a class="anchor" id="a0e5c7aed7d7dbee9152282ca9d3627d2"></a><!-- doxytag: member="ost::UDPSocket::UDPSocket" ref="a0e5c7aed7d7dbee9152282ca9d3627d2" args="(const IPV4Address &bind, tpport_t port)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::UDPSocket::UDPSocket </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></td> </tr> </table> </div> <div class="memdoc"> <p>Create a UDP socket and 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. </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="a781894813be82c4f6aa5827fa087fb68"></a><!-- doxytag: member="ost::UDPSocket::UDPSocket" ref="a781894813be82c4f6aa5827fa087fb68" args="(const IPV6Address &bind, tpport_t port)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::UDPSocket::UDPSocket </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></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a513c2f1fb2f84a295fe78527e47e052e"></a><!-- doxytag: member="ost::UDPSocket::~UDPSocket" ref="a513c2f1fb2f84a295fe78527e47e052e" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual ost::UDPSocket::~UDPSocket </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Destroy a UDP socket as a socket. </p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a197a034e4ebc8172ede75d1d69616f15"></a><!-- doxytag: member="ost::UDPSocket::connect" ref="a197a034e4ebc8172ede75d1d69616f15" args="(const char *service)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ost::UDPSocket::connect </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>service</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a759c8f5c76cacfdeac979a5034d658d7"></a><!-- doxytag: member="ost::UDPSocket::connect" ref="a759c8f5c76cacfdeac979a5034d658d7" args="(const IPV6Host &host, tpport_t port)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ost::UDPSocket::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></td> </tr> </table> </div> <div class="memdoc"> <p>Reimplemented in <a class="el" href="classost_1_1_u_d_p_receive.html#a0e8c851cbc68729353b76894107091e9">ost::UDPReceive</a>, and <a class="el" href="classost_1_1_u_d_p_duplex.html#a60abbfd8ef6eac65c8b9726a1d489440">ost::UDPDuplex</a>.</p> </div> </div> <a class="anchor" id="a519db2909a1c43e791e6620b758d3fdc"></a><!-- doxytag: member="ost::UDPSocket::connect" ref="a519db2909a1c43e791e6620b758d3fdc" args="(const IPV4Host &host, tpport_t port)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ost::UDPSocket::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></td> </tr> </table> </div> <div class="memdoc"> <p>Reimplemented in <a class="el" href="classost_1_1_u_d_p_transmit.html#ad9b9d46dfaf10ad1555c0fa08db339be">ost::UDPTransmit</a>, <a class="el" href="classost_1_1_u_d_p_receive.html#aa669c5dcf686c200752d4ca125f9f4a6">ost::UDPReceive</a>, and <a class="el" href="classost_1_1_u_d_p_duplex.html#a219b6497a5dd25e943639cfc1bbb8f81">ost::UDPDuplex</a>.</p> </div> </div> <a class="anchor" id="acb4faa86204e7b37bf447f4802c8940d"></a><!-- doxytag: member="ost::UDPSocket::disconnect" ref="acb4faa86204e7b37bf447f4802c8940d" args="(void)" --> <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::UDPSocket::disconnect </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Disassociate this socket from any host connection. </p> <p>No data should be read or written until a connection is established. </p> <p>Reimplemented in <a class="el" href="classost_1_1_u_d_p_duplex.html#afa88407cb5be59e11154ce250a5a5c5c">ost::UDPDuplex</a>.</p> </div> </div> <a class="anchor" id="aef52438ac3e537420d3264690a628dfa"></a><!-- doxytag: member="ost::UDPSocket::getInterfaceIndex" ref="aef52438ac3e537420d3264690a628dfa" args="(const char *ethX, int &InterfaceIndex)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Socket::Error</a> ost::UDPSocket::getInterfaceIndex </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>ethX</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int & </td> <td class="paramname"> <em>InterfaceIndex</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>get the interface index for a named network device </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>ethX</em> </td><td>is device name, like "eth0" or "eth1" </td></tr> <tr><td valign="top"></td><td valign="top"><em>InterfaceIndex</em> </td><td>is the index value returned by os </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="aa2d073bd4fa3c3f1c7b70629996c67f7"></a><!-- doxytag: member="ost::UDPSocket::getIPV4Peer" ref="aa2d073bd4fa3c3f1c7b70629996c67f7" args="(tpport_t *port=NULL) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> ost::UDPSocket::getIPV4Peer </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</td> </tr> </table> </div> <div class="memdoc"> <p>Examine address of sender of next waiting packet. </p> <p>This also sets "peer" address to the sender so that the next "send" message acts as a "reply". This additional behavior overides the standard socket getSender behavior.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>pointer to hold port number. </td></tr> </table> </dd> </dl> <p>Reimplemented from <a class="el" href="classost_1_1_socket.html#a8c8d2cfd48c75b03dc776b38b1c095f7">ost::Socket</a>.</p> </div> </div> <a class="anchor" id="a37b34f874ffb96bfc933b4eda0f6e80c"></a><!-- doxytag: member="ost::UDPSocket::getIPV6Peer" ref="a37b34f874ffb96bfc933b4eda0f6e80c" args="(tpport_t *port=NULL) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> ost::UDPSocket::getIPV6Peer </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</td> </tr> </table> </div> <div class="memdoc"> <p>Reimplemented from <a class="el" href="classost_1_1_socket.html#ad625daf4cffb541c5e8592792d4ee77e">ost::Socket</a>.</p> </div> </div> <a class="anchor" id="a5d06e7131790dd26cc3cf0b1531af3a2"></a><!-- doxytag: member="ost::UDPSocket::getPeer" ref="a5d06e7131790dd26cc3cf0b1531af3a2" args="(tpport_t *port=NULL) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> ost::UDPSocket::getPeer </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> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Reimplemented from <a class="el" href="classost_1_1_socket.html#a6fd1dffdfe9606e56fba838559ff6d67">ost::Socket</a>.</p> </div> </div> <a class="anchor" id="aa0277a5c4667f5c9e192c1dc5486b5fb"></a><!-- doxytag: member="ost::UDPSocket::join" ref="aa0277a5c4667f5c9e192c1dc5486b5fb" args="(const IPV4Multicast &ia, int InterfaceIndex)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Socket::Error</a> ost::UDPSocket::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> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>InterfaceIndex</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>join a multicast group on a particular interface </p> <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>is the multicast address to use </td></tr> <tr><td valign="top"></td><td valign="top"><em>InterfaceIndex</em> </td><td>is the index value returned by getInterfaceIndex </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a64b09e6ac9325d8f44d7ca7ed59215bf"></a><!-- doxytag: member="ost::UDPSocket::peek" ref="a64b09e6ac9325d8f44d7ca7ed59215bf" args="(void *buf, size_t len)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ssize_t ost::UDPSocket::peek </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>Examine contents of next waiting packet. </p> <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>pointer to packet buffer for contents. </td></tr> <tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>of packet buffer. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>number of bytes examined. </dd></dl> </div> </div> <a class="anchor" id="a3f5c684f2fc3d1b65a1a5e2966f5b292"></a><!-- doxytag: member="ost::UDPSocket::receive" ref="a3f5c684f2fc3d1b65a1a5e2966f5b292" args="(void *buf, size_t len, bool reply=false)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ssize_t ost::UDPSocket::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> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>reply</em> = <code>false</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Receive a message from any host. </p> <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>pointer to packet buffer to receive. </td></tr> <tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>of packet buffer to receive. </td></tr> <tr><td valign="top"></td><td valign="top"><em>reply</em> </td><td>save sender address for reply if true. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>number of bytes received. </dd></dl> </div> </div> <a class="anchor" id="a4d58bb8e7a0ea0112da563bfd2eaa947"></a><!-- doxytag: member="ost::UDPSocket::send" ref="a4d58bb8e7a0ea0112da563bfd2eaa947" args="(const void *buf, size_t len)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ssize_t ost::UDPSocket::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></td> </tr> </table> </div> <div class="memdoc"> <p>Send a message packet to a peer host. </p> <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>pointer to packet buffer to send. </td></tr> <tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>of packet buffer to send. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>number of bytes sent. </dd></dl> <p>Reimplemented in <a class="el" href="classost_1_1_u_d_p_transmit.html#ac20e40569ec5502849fa3337dcfdf611">ost::UDPTransmit</a>.</p> </div> </div> <a class="anchor" id="afbf86c658fcf48b0ba946a238df091d3"></a><!-- doxytag: member="ost::UDPSocket::setLoopback" ref="afbf86c658fcf48b0ba946a238df091d3" 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::UDPSocket::setLoopback </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>Set the loopback. </p> <p>References <a class="el" href="classost_1_1_socket.html#a08683bc57bede572b8effb07a3fc68dc">ost::Socket::setLoopbackByFamily()</a>.</p> </div> </div> <a class="anchor" id="ace98f5833ad9834af24e78697699c912"></a><!-- doxytag: member="ost::UDPSocket::setMulticast" ref="ace98f5833ad9834af24e78697699c912" 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::UDPSocket::setMulticast </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>Set the multicast. </p> <p>Reimplemented in <a class="el" href="classost_1_1_u_d_p_transmit.html#a4e5c8fb7c2ea5f78454d303169d68b61">ost::UDPTransmit</a>, and <a class="el" href="classost_1_1_u_d_p_receive.html#aa513f9513f012494e0fbd61d84c665f6">ost::UDPReceive</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="a1bef3ed88eb3852679642510864b419c"></a><!-- doxytag: member="ost::UDPSocket::setPeer" ref="a1bef3ed88eb3852679642510864b419c" args="(const char *service)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ost::UDPSocket::setPeer </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>service</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Associate socket with a named connection. </p> </div> </div> <a class="anchor" id="a943d73dd40035a5d675a9d4a7e102725"></a><!-- doxytag: member="ost::UDPSocket::setPeer" ref="a943d73dd40035a5d675a9d4a7e102725" args="(const IPV6Host &host, tpport_t port)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ost::UDPSocket::setPeer </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></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a0a1aed4af396b54c42d5a616688b1426"></a><!-- doxytag: member="ost::UDPSocket::setPeer" ref="a0a1aed4af396b54c42d5a616688b1426" args="(const IPV4Host &host, tpport_t port)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ost::UDPSocket::setPeer </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></td> </tr> </table> </div> <div class="memdoc"> <p>set the peer address to send message packets to. </p> <p>This can be set before every <a class="el" href="classost_1_1_u_d_p_socket.html#a4d58bb8e7a0ea0112da563bfd2eaa947" title="Send a message packet to a peer host.">send()</a> call if nessisary.</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 to send packets to. </td></tr> <tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>number to deliver packets to. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ad3cf52efd8d79b40796d67b59285d2cf"></a><!-- doxytag: member="ost::UDPSocket::setTimeToLive" ref="ad3cf52efd8d79b40796d67b59285d2cf" args="(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::UDPSocket::setTimeToLive </td> <td>(</td> <td class="paramtype">char </td> <td class="paramname"> <em>ttl</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Set time to live. </p> <p>References <a class="el" href="classost_1_1_socket.html#a23d69227150ae996caf76b01024c1b20">ost::Socket::setTimeToLiveByFamily()</a>.</p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="afe9f40091dc6c57c6743cf0720ab5938"></a><!-- doxytag: member="ost::UDPSocket::family" ref="afe9f40091dc6c57c6743cf0720ab5938" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><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">ost::UDPSocket::family</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="ad4c15c1eb5dd4f0ce6d4487b43869215"></a><!-- doxytag: member="ost::UDPSocket::ipv4" ref="ad4c15c1eb5dd4f0ce6d4487b43869215" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct sockaddr_in <a class="el" href="classost_1_1_u_d_p_socket.html#ad4c15c1eb5dd4f0ce6d4487b43869215">ost::UDPSocket::ipv4</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a9842db7ec82d337e554d264e7230a705"></a><!-- doxytag: member="ost::UDPSocket::ipv6" ref="a9842db7ec82d337e554d264e7230a705" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">struct sockaddr_in6 <a class="el" href="classost_1_1_u_d_p_socket.html#a9842db7ec82d337e554d264e7230a705">ost::UDPSocket::ipv6</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a124024a4168c6412b67490409a329820"></a><!-- doxytag: member="ost::UDPSocket::peer" ref="a124024a4168c6412b67490409a329820" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">union { ... } <a class="el" href="classost_1_1_u_d_p_socket.html#a124024a4168c6412b67490409a329820">ost::UDPSocket::peer</a><code> [protected]</code></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>