Host library for controlling a WiConnect enabled Wi-Fi module.
Dependents: wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more
Diff: doc/html/group__api__socket__udp.html
- Revision:
- 17:7268f365676b
- Parent:
- 13:2b51f5267c92
- Child:
- 21:17bb3eddcbae
diff -r 7f1d6d359787 -r 7268f365676b doc/html/group__api__socket__udp.html --- a/doc/html/group__api__socket__udp.html Wed Aug 13 04:41:04 2014 -0700 +++ b/doc/html/group__api__socket__udp.html Sat Aug 23 05:39:17 2014 -0700 @@ -109,21 +109,21 @@ <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> -<tr class="memitem:ga1a7ee47642c572db433e68eaee65c44c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__udp.html#ga1a7ee47642c572db433e68eaee65c44c">wiconnect::SocketInterface::udpConnect</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &socket, const char *host, uint16_t remortPort, uint16_t localPort=<a class="el" href="group__api__socket__macro.html#gae54117ebe433295ef992b9ca83c46d98">SOCKET_ANY_PORT</a>, <a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin=NC)</td></tr> -<tr class="memdesc:ga1a7ee47642c572db433e68eaee65c44c"><td class="mdescLeft"> </td><td class="mdescRight">Connect to remote UDP server. <a href="#ga1a7ee47642c572db433e68eaee65c44c">More...</a><br /></td></tr> -<tr class="separator:ga1a7ee47642c572db433e68eaee65c44c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaee37b416b1e68eaefec1b49af04c87a1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__udp.html#gaee37b416b1e68eaefec1b49af04c87a1">wiconnect::SocketInterface::udpConnect</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &socket, const char *host, uint16_t remortPort, uint16_t localPort=<a class="el" href="group__api__socket__macro.html#gae54117ebe433295ef992b9ca83c46d98">SOCKET_ANY_PORT</a>, <a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin=NC)</td></tr> +<tr class="memdesc:gaee37b416b1e68eaefec1b49af04c87a1"><td class="mdescLeft"> </td><td class="mdescRight">Connect to remote UDP server. <a href="#gaee37b416b1e68eaefec1b49af04c87a1">More...</a><br /></td></tr> +<tr class="separator:gaee37b416b1e68eaefec1b49af04c87a1"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>UDP methods. </p> <h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="ga1a7ee47642c572db433e68eaee65c44c"></a> +<a class="anchor" id="gaee37b416b1e68eaefec1b49af04c87a1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::udpConnect </td> <td>(</td> - <td class="paramtype"><a class="el" href="classwiconnect_1_1_socket.html">Socket</a> & </td> + <td class="paramtype"><a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> & </td> <td class="paramname"><em>socket</em>, </td> </tr> <tr> @@ -161,7 +161,7 @@ <p>Connect to remote UDP server. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[out]</td><td class="paramname">socket</td><td>UDP <a class="el" href="classwiconnect_1_1_socket.html">Socket</a> object of opened connection. </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">socket</td><td>UDP <a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> object of opened connection. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">host</td><td>The host/IP address of the remote UDP server </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">remortPort</td><td>The port of the remote server </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">localPort</td><td>Optional, port of module's side of the connection </td></tr>