Diff: doc/html/group__api__socket__tcp.html

Revision:

29:b6af04b77a56

Parent:

26:8067e3d463d3

--- a/doc/html/group__api__socket__tcp.html	Mon Oct 27 13:32:40 2014 -0700
+++ b/doc/html/group__api__socket__tcp.html	Mon Oct 27 13:42:26 2014 -0700
@@ -109,15 +109,15 @@
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 Functions</h2></td></tr>
-<tr class="memitem:ga4a788d604d759b5da51f682b998b9bd2"><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__tcp.html#ga4a788d604d759b5da51f682b998b9bd2">wiconnect::SocketInterface::tcpConnect</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, const char *host, uint16_t remortPort, <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:ga4a788d604d759b5da51f682b998b9bd2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote TCP server.  <a href="#ga4a788d604d759b5da51f682b998b9bd2">More...</a><br /></td></tr>
-<tr class="separator:ga4a788d604d759b5da51f682b998b9bd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga563831b33089437233f128483d034578"><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__tcp.html#ga563831b33089437233f128483d034578">wiconnect::SocketInterface::tcpListen</a> (uint16_t listeningPort, int maxClients=0, <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:ga563831b33089437233f128483d034578"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start internal TCP server and listen on specified port.  <a href="#ga563831b33089437233f128483d034578">More...</a><br /></td></tr>
-<tr class="separator:ga563831b33089437233f128483d034578"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga0ea4efc810c7c5a9fbd96fcc627633b3"><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__tcp.html#ga0ea4efc810c7c5a9fbd96fcc627633b3">wiconnect::SocketInterface::tcpAccept</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, int timeoutMs=<a class="el" href="group__api__core__macro.html#ga580e5f45fee866c845e0d3fd1eb1744a">WICONNECT_WAIT_FOREVER</a>)</td></tr>
-<tr class="memdesc:ga0ea4efc810c7c5a9fbd96fcc627633b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for next client to connect to TCP server.  <a href="#ga0ea4efc810c7c5a9fbd96fcc627633b3">More...</a><br /></td></tr>
-<tr class="separator:ga0ea4efc810c7c5a9fbd96fcc627633b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gad8e8632715a38222ce4fea5fe0aaf527"><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__tcp.html#gad8e8632715a38222ce4fea5fe0aaf527">wiconnect::SocketInterface::tcpConnect</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, const char *host, uint16_t remortPort GPIO_IRQ_ARG_NC)</td></tr>
+<tr class="memdesc:gad8e8632715a38222ce4fea5fe0aaf527"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote TCP server.  <a href="#gad8e8632715a38222ce4fea5fe0aaf527">More...</a><br /></td></tr>
+<tr class="separator:gad8e8632715a38222ce4fea5fe0aaf527"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga9f4f3e53ea7f4e84d43529da8580aaaa"><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__tcp.html#ga9f4f3e53ea7f4e84d43529da8580aaaa">wiconnect::SocketInterface::tcpListen</a> (uint16_t listeningPort, int maxClients=0 GPIO_IRQ_ARG_NC)</td></tr>
+<tr class="memdesc:ga9f4f3e53ea7f4e84d43529da8580aaaa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start internal TCP server and listen on specified port.  <a href="#ga9f4f3e53ea7f4e84d43529da8580aaaa">More...</a><br /></td></tr>
+<tr class="separator:ga9f4f3e53ea7f4e84d43529da8580aaaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga9e12bc568b7e8d72152e53a90de13035"><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__tcp.html#ga9e12bc568b7e8d72152e53a90de13035">wiconnect::SocketInterface::tcpAccept</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, uint32_t timeoutMs=<a class="el" href="group__api__core__macro.html#ga580e5f45fee866c845e0d3fd1eb1744a">WICONNECT_WAIT_FOREVER</a>)</td></tr>
+<tr class="memdesc:ga9e12bc568b7e8d72152e53a90de13035"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for next client to connect to TCP server.  <a href="#ga9e12bc568b7e8d72152e53a90de13035">More...</a><br /></td></tr>
+<tr class="separator:ga9e12bc568b7e8d72152e53a90de13035"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ga3d0137ebe308674e75f81457c38679d0"><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__tcp.html#ga3d0137ebe308674e75f81457c38679d0">wiconnect::SocketInterface::tcpServerStop</a> (void)</td></tr>
 <tr class="memdesc:ga3d0137ebe308674e75f81457c38679d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop TCP server from listening on port. Close all connected clients.  <a href="#ga3d0137ebe308674e75f81457c38679d0">More...</a><br /></td></tr>
 <tr class="separator:ga3d0137ebe308674e75f81457c38679d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -125,7 +125,7 @@
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <p>TCP methods. </p>
 <h2 class="groupheader">Function Documentation</h2>
-<a class="anchor" id="ga0ea4efc810c7c5a9fbd96fcc627633b3"></a>
+<a class="anchor" id="ga9e12bc568b7e8d72152e53a90de13035"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
@@ -138,7 +138,7 @@
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype">int&#160;</td>
+          <td class="paramtype">uint32_t&#160;</td>
           <td class="paramname"><em>timeoutMs</em> = <code><a class="el" href="group__api__core__macro.html#ga580e5f45fee866c845e0d3fd1eb1744a">WICONNECT_WAIT_FOREVER</a></code>&#160;</td>
         </tr>
         <tr>
@@ -161,7 +161,7 @@
 
 </div>
 </div>
-<a class="anchor" id="ga4a788d604d759b5da51f682b998b9bd2"></a>
+<a class="anchor" id="gad8e8632715a38222ce4fea5fe0aaf527"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
@@ -180,14 +180,8 @@
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype">uint16_t&#160;</td>
-          <td class="paramname"><em>remortPort</em>, </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="paramtype">uint16_t remortPort&#160;</td>
+          <td class="paramname"><em>GPIO_IRQ_ARG_NC</em>&#160;</td>
         </tr>
         <tr>
           <td></td>
@@ -203,7 +197,7 @@
     <tr><td class="paramdir">[out]</td><td class="paramname">socket</td><td>TCP <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 TCP 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">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>
@@ -211,7 +205,7 @@
 
 </div>
 </div>
-<a class="anchor" id="ga563831b33089437233f128483d034578"></a>
+<a class="anchor" id="ga9f4f3e53ea7f4e84d43529da8580aaaa"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
@@ -225,13 +219,7 @@
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">int&#160;</td>
-          <td class="paramname"><em>maxClients</em> = <code>0</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>maxClients</em> = <code>0&#160;GPIO_IRQ_ARG_NC</code>&#160;</td>
         </tr>
         <tr>
           <td></td>
@@ -246,7 +234,7 @@
   <table class="params">
     <tr><td class="paramdir">[in]</td><td class="paramname">listeningPort</td><td>The local port the server should listen on </td></tr>
     <tr><td class="paramdir">[in]</td><td class="paramname">maxClients</td><td>Optional, the maximum simultaneous connected clients, 0 is default, 1-8 valid range </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>