diff options
| author | Erwin Nindl <nine@wirdorange.org> | 2007-10-07 22:07:03 +0000 |
|---|---|---|
| committer | Erwin Nindl <nine@wirdorange.org> | 2007-10-07 22:07:03 +0000 |
| commit | 7763f07327f3abce839a690df46ced3bfd1d3d09 (patch) | |
| tree | c80abe2cf8e137edba89cad9f14f63048275cee1 /doc/html/classUDPSocket.html | |
| parent | added doxygen, and doxygen makefile target (diff) | |
added doxygen generatet documentation
Diffstat (limited to 'doc/html/classUDPSocket.html')
| -rw-r--r-- | doc/html/classUDPSocket.html | 404 |
1 files changed, 404 insertions, 0 deletions
diff --git a/doc/html/classUDPSocket.html b/doc/html/classUDPSocket.html new file mode 100644 index 0000000..d3c693e --- /dev/null +++ b/doc/html/classUDPSocket.html @@ -0,0 +1,404 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>anytun: UDPSocket Class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.1 --> +<div class="tabs"> + <ul> + <li><a href="main.html"><span>Main Page</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li id="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul></div> +<div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul></div> +<h1>UDPSocket Class Reference</h1><!-- doxytag: class="UDPSocket" --><!-- doxytag: inherits="CommunicatingSocket" --><code>#include <<a class="el" href="PracticalSocket_8h-source.html">PracticalSocket.h</a>></code> +<p> +<p>Inheritance diagram for UDPSocket: +<p><center><img src="classUDPSocket.png" usemap="#UDPSocket_map" border="0" alt=""></center> +<map name="UDPSocket_map"> +<area href="classCommunicatingSocket.html" alt="CommunicatingSocket" shape="rect" coords="0,56,135,80"> +<area href="classSocket.html" alt="Socket" shape="rect" coords="0,0,135,24"> +<area href="classUDPPacketSource.html" alt="UDPPacketSource" shape="rect" coords="0,168,135,192"> +</map> +<a href="classUDPSocket-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classUDPSocket.html#4f86f3023f5a08f6355802599a10e100">UDPSocket</a> () throw (SocketException)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classUDPSocket.html#14dcb55c4b60b12d4a7fff648cbb825f">UDPSocket</a> (unsigned short localPort) throw (SocketException)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classUDPSocket.html#f19281c523f15ed30d7d78f09033713d">UDPSocket</a> (const string &localAddress, unsigned short localPort) throw (SocketException)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUDPSocket.html#7482e8e61cef160e1a7c0d6ac15c01be">disconnect</a> () throw (SocketException)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUDPSocket.html#41a3595e226f273953cbd38618af5d5b">sendTo</a> (const void *buffer, int bufferLen, const string &foreignAddress, unsigned short foreignPort) throw (SocketException)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classUDPSocket.html#bcd5c064e2496bd8b1888fd4e1b68949">recvFrom</a> (void *buffer, int bufferLen, string &sourceAddress, unsigned short &sourcePort) throw (SocketException)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUDPSocket.html#4dcfff33b45d1b84b5a602fc6f4a27f8">setMulticastTTL</a> (unsigned char multicastTTL) throw (SocketException)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUDPSocket.html#1b20c1e8bd49a9bd9b53dd4f1c8d4c11">joinGroup</a> (const string &multicastGroup) throw (SocketException)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUDPSocket.html#78835eaeca8a5ac039b4579c795e3640">leaveGroup</a> (const string &multicastGroup) throw (SocketException)</td></tr> + +<tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUDPSocket.html#316f08a017aa160643812f3c08734d27">setBroadcast</a> ()</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +UDP socket class +<p> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="4f86f3023f5a08f6355802599a10e100"></a><!-- doxytag: member="UDPSocket::UDPSocket" ref="4f86f3023f5a08f6355802599a10e100" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">UDPSocket::UDPSocket </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"> throw (<a class="el" href="classSocketException.html">SocketException</a>)</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Construct a UDP socket <dl compact><dt><b>Exceptions:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSocketException.html">SocketException</a></em> </td><td>thrown if unable to create UDP socket </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="14dcb55c4b60b12d4a7fff648cbb825f"></a><!-- doxytag: member="UDPSocket::UDPSocket" ref="14dcb55c4b60b12d4a7fff648cbb825f" args="(unsigned short localPort)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">UDPSocket::UDPSocket </td> + <td>(</td> + <td class="paramtype">unsigned short </td> + <td class="paramname"> <em>localPort</em> </td> + <td> ) </td> + <td width="100%"> throw (<a class="el" href="classSocketException.html">SocketException</a>)</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Construct a UDP socket with the given local port <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>localPort</em> </td><td>local port </td></tr> + </table> +</dl> +<dl compact><dt><b>Exceptions:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSocketException.html">SocketException</a></em> </td><td>thrown if unable to create UDP socket </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="f19281c523f15ed30d7d78f09033713d"></a><!-- doxytag: member="UDPSocket::UDPSocket" ref="f19281c523f15ed30d7d78f09033713d" args="(const string &localAddress, unsigned short localPort)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">UDPSocket::UDPSocket </td> + <td>(</td> + <td class="paramtype">const string & </td> + <td class="paramname"> <em>localAddress</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned short </td> + <td class="paramname"> <em>localPort</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td width="100%"> throw (<a class="el" href="classSocketException.html">SocketException</a>)</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Construct a UDP socket with the given local port and address <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>localAddress</em> </td><td>local address </td></tr> + <tr><td valign="top"></td><td valign="top"><em>localPort</em> </td><td>local port </td></tr> + </table> +</dl> +<dl compact><dt><b>Exceptions:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSocketException.html">SocketException</a></em> </td><td>thrown if unable to create UDP socket </td></tr> + </table> +</dl> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="7482e8e61cef160e1a7c0d6ac15c01be"></a><!-- doxytag: member="UDPSocket::disconnect" ref="7482e8e61cef160e1a7c0d6ac15c01be" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void UDPSocket::disconnect </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"> throw (<a class="el" href="classSocketException.html">SocketException</a>)</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Unset foreign address and port <dl class="return" compact><dt><b>Returns:</b></dt><dd>true if disassociation is successful </dd></dl> +<dl compact><dt><b>Exceptions:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSocketException.html">SocketException</a></em> </td><td>thrown if unable to disconnect UDP socket </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="41a3595e226f273953cbd38618af5d5b"></a><!-- doxytag: member="UDPSocket::sendTo" ref="41a3595e226f273953cbd38618af5d5b" args="(const void *buffer, int bufferLen, const string &foreignAddress, unsigned short foreignPort)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void UDPSocket::sendTo </td> + <td>(</td> + <td class="paramtype">const void * </td> + <td class="paramname"> <em>buffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>bufferLen</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const string & </td> + <td class="paramname"> <em>foreignAddress</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned short </td> + <td class="paramname"> <em>foreignPort</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td width="100%"> throw (<a class="el" href="classSocketException.html">SocketException</a>)</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Send the given buffer as a UDP datagram to the specified address/port <dl compact><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>buffer to be written </td></tr> + <tr><td valign="top"></td><td valign="top"><em>bufferLen</em> </td><td>number of bytes to write </td></tr> + <tr><td valign="top"></td><td valign="top"><em>foreignAddress</em> </td><td>address (IP address or name) to send to </td></tr> + <tr><td valign="top"></td><td valign="top"><em>foreignPort</em> </td><td>port number to send to </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if send is successful </dd></dl> +<dl compact><dt><b>Exceptions:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSocketException.html">SocketException</a></em> </td><td>thrown if unable to send datagram </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="bcd5c064e2496bd8b1888fd4e1b68949"></a><!-- doxytag: member="UDPSocket::recvFrom" ref="bcd5c064e2496bd8b1888fd4e1b68949" args="(void *buffer, int bufferLen, string &sourceAddress, unsigned short &sourcePort)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int UDPSocket::recvFrom </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>buffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>bufferLen</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">string & </td> + <td class="paramname"> <em>sourceAddress</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned short & </td> + <td class="paramname"> <em>sourcePort</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td width="100%"> throw (<a class="el" href="classSocketException.html">SocketException</a>)</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Read read up to bufferLen bytes data from this socket. The given buffer is where the data will be placed <dl compact><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>buffer to receive data </td></tr> + <tr><td valign="top"></td><td valign="top"><em>bufferLen</em> </td><td>maximum number of bytes to receive </td></tr> + <tr><td valign="top"></td><td valign="top"><em>sourceAddress</em> </td><td>address of datagram source </td></tr> + <tr><td valign="top"></td><td valign="top"><em>sourcePort</em> </td><td>port of data source </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>number of bytes received and -1 for error </dd></dl> +<dl compact><dt><b>Exceptions:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSocketException.html">SocketException</a></em> </td><td>thrown if unable to receive datagram </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="4dcfff33b45d1b84b5a602fc6f4a27f8"></a><!-- doxytag: member="UDPSocket::setMulticastTTL" ref="4dcfff33b45d1b84b5a602fc6f4a27f8" args="(unsigned char multicastTTL)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void UDPSocket::setMulticastTTL </td> + <td>(</td> + <td class="paramtype">unsigned char </td> + <td class="paramname"> <em>multicastTTL</em> </td> + <td> ) </td> + <td width="100%"> throw (<a class="el" href="classSocketException.html">SocketException</a>)</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the multicast TTL <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>multicastTTL</em> </td><td>multicast TTL </td></tr> + </table> +</dl> +<dl compact><dt><b>Exceptions:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSocketException.html">SocketException</a></em> </td><td>thrown if unable to set TTL </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="1b20c1e8bd49a9bd9b53dd4f1c8d4c11"></a><!-- doxytag: member="UDPSocket::joinGroup" ref="1b20c1e8bd49a9bd9b53dd4f1c8d4c11" args="(const string &multicastGroup)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void UDPSocket::joinGroup </td> + <td>(</td> + <td class="paramtype">const string & </td> + <td class="paramname"> <em>multicastGroup</em> </td> + <td> ) </td> + <td width="100%"> throw (<a class="el" href="classSocketException.html">SocketException</a>)</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Join the specified multicast group <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>multicastGroup</em> </td><td>multicast group address to join </td></tr> + </table> +</dl> +<dl compact><dt><b>Exceptions:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSocketException.html">SocketException</a></em> </td><td>thrown if unable to join group </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="78835eaeca8a5ac039b4579c795e3640"></a><!-- doxytag: member="UDPSocket::leaveGroup" ref="78835eaeca8a5ac039b4579c795e3640" args="(const string &multicastGroup)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void UDPSocket::leaveGroup </td> + <td>(</td> + <td class="paramtype">const string & </td> + <td class="paramname"> <em>multicastGroup</em> </td> + <td> ) </td> + <td width="100%"> throw (<a class="el" href="classSocketException.html">SocketException</a>)</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Leave the specified multicast group <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>multicastGroup</em> </td><td>multicast group address to leave </td></tr> + </table> +</dl> +<dl compact><dt><b>Exceptions:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classSocketException.html">SocketException</a></em> </td><td>thrown if unable to leave group </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="316f08a017aa160643812f3c08734d27"></a><!-- doxytag: member="UDPSocket::setBroadcast" ref="316f08a017aa160643812f3c08734d27" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void UDPSocket::setBroadcast </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="PracticalSocket_8h-source.html">PracticalSocket.h</a><li><a class="el" href="PracticalSocket_8cpp.html">PracticalSocket.cpp</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Sun Oct 7 23:43:50 2007 for anytun by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address> +</body> +</html> |