Diff: doc/html/group__api__socket__udp.html

Revision:

29:b6af04b77a56

Parent:

26:8067e3d463d3

diff -r 3c52f578708a -r b6af04b77a56 doc/html/group__api__socket__udp.html
--- a/doc/html/group__api__socket__udp.html	Mon Oct 27 13:32:40 2014 -0700
+++ b/doc/html/group__api__socket__udp.html	Mon Oct 27 13:42:26 2014 -0700
@@ -109,14 +109,17 @@
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 Functions</h2></td></tr>
-<tr class="memitem:ga80f1d19174124f3d0f246e1c1201b3ec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__udp.html#ga80f1d19174124f3d0f246e1c1201b3ec">wiconnect::SocketInterface::udpConnect</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;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=<a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>)</td></tr>
-<tr class="memdesc:ga80f1d19174124f3d0f246e1c1201b3ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote UDP server.  <a href="#ga80f1d19174124f3d0f246e1c1201b3ec">More...</a><br /></td></tr>
-<tr class="separator:ga80f1d19174124f3d0f246e1c1201b3ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga0ca5eabcd64ce45b574205447101f8aa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__udp.html#ga0ca5eabcd64ce45b574205447101f8aa">wiconnect::SocketInterface::udpConnect</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, const char *host, uint16_t remortPort, uint16_t localPort=<a class="el" href="group__api__socket__macro.html#gae54117ebe433295ef992b9ca83c46d98">SOCKET_ANY_PORT</a> GPIO_IRQ_ARG_NC)</td></tr>
+<tr class="memdesc:ga0ca5eabcd64ce45b574205447101f8aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote UDP server.  <a href="#ga0ca5eabcd64ce45b574205447101f8aa">More...</a><br /></td></tr>
+<tr class="separator:ga0ca5eabcd64ce45b574205447101f8aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga067fb0d662d8e27e3f5b561ded29a51a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__udp.html#ga067fb0d662d8e27e3f5b561ded29a51a">wiconnect::SocketInterface::udpListen</a> (<a class="el" href="classwiconnect_1_1_wiconnect_udp_server.html">WiconnectUdpServer</a> &amp;udpServer, uint16_t listeningPort)</td></tr>
+<tr class="memdesc:ga067fb0d662d8e27e3f5b561ded29a51a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start a UDP server listening on the given port.  <a href="#ga067fb0d662d8e27e3f5b561ded29a51a">More...</a><br /></td></tr>
+<tr class="separator:ga067fb0d662d8e27e3f5b561ded29a51a"><td class="memSeparator" colspan="2">&#160;</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="ga80f1d19174124f3d0f246e1c1201b3ec"></a>
+<a class="anchor" id="ga0ca5eabcd64ce45b574205447101f8aa"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
@@ -142,13 +145,7 @@
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">uint16_t&#160;</td>
-          <td class="paramname"><em>localPort</em> = <code><a class="el" href="group__api__socket__macro.html#gae54117ebe433295ef992b9ca83c46d98">SOCKET_ANY_PORT</a></code>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype"><a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a>&#160;</td>
-          <td class="paramname"><em>irqPin</em> = <code><a class="el" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a></code>&#160;</td>
+          <td class="paramname"><em>localPort</em> = <code><a class="el" href="group__api__socket__macro.html#gae54117ebe433295ef992b9ca83c46d98">SOCKET_ANY_PORT</a>&#160;GPIO_IRQ_ARG_NC</code>&#160;</td>
         </tr>
         <tr>
           <td></td>
@@ -165,7 +162,43 @@
     <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>
-    <tr><td class="paramdir">[in]</td><td class="paramname">irqPin</td><td>Optional, Data available external interrupt pin. See <a class="el" href="group__api__socket__misc.html#ga94d1eb5407cb8b60ad366ecbe0e1b52a" title="Register a host pin as an external interrupt. When the external interrupt is triggered, the supplied callback is executed. ">registerSocketIrqHandler()</a> for more info </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">irqPin</td><td>Optional, Data available external interrupt pin. See registerSocketIrqHandler() for more info </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="ga067fb0d662d8e27e3f5b561ded29a51a"></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::udpListen </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="classwiconnect_1_1_wiconnect_udp_server.html">WiconnectUdpServer</a> &amp;&#160;</td>
+          <td class="paramname"><em>udpServer</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">uint16_t&#160;</td>
+          <td class="paramname"><em>listeningPort</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Start a UDP server listening on the given port. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[out]</td><td class="paramname">udpServer</td><td>UDP <a class="el" href="classwiconnect_1_1_wiconnect_udp_server.html">WiconnectUdpServer</a> object listening server </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">listeningPort</td><td>The port the UDP server listens on </td></tr>
   </table>
   </dd>
 </dl>