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__tcp.html
- Revision:
- 17:7268f365676b
- Parent:
- 13:2b51f5267c92
- Child:
- 21:17bb3eddcbae
--- a/doc/html/group__api__socket__tcp.html Wed Aug 13 04:41:04 2014 -0700 +++ b/doc/html/group__api__socket__tcp.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:ga74f8ac6b81d3b96a26411b4faffc6a01"><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__tcp.html#ga74f8ac6b81d3b96a26411b4faffc6a01">wiconnect::SocketInterface::tcpConnect</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &socket, const char *host, uint16_t remortPort, <a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin=NC)</td></tr> -<tr class="memdesc:ga74f8ac6b81d3b96a26411b4faffc6a01"><td class="mdescLeft"> </td><td class="mdescRight">Connect to remote TCP server. <a href="#ga74f8ac6b81d3b96a26411b4faffc6a01">More...</a><br /></td></tr> -<tr class="separator:ga74f8ac6b81d3b96a26411b4faffc6a01"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gafe15edec5f45f82a2ef82f0b0d5a6cb0"><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__tcp.html#gafe15edec5f45f82a2ef82f0b0d5a6cb0">wiconnect::SocketInterface::tcpConnect</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &socket, const char *host, uint16_t remortPort, <a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin=NC)</td></tr> +<tr class="memdesc:gafe15edec5f45f82a2ef82f0b0d5a6cb0"><td class="mdescLeft"> </td><td class="mdescRight">Connect to remote TCP server. <a href="#gafe15edec5f45f82a2ef82f0b0d5a6cb0">More...</a><br /></td></tr> +<tr class="separator:gafe15edec5f45f82a2ef82f0b0d5a6cb0"><td class="memSeparator" colspan="2"> </td></tr> </table> <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="ga74f8ac6b81d3b96a26411b4faffc6a01"></a> +<a class="anchor" id="gafe15edec5f45f82a2ef82f0b0d5a6cb0"></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::tcpConnect </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> @@ -155,7 +155,7 @@ <p>Connect to remote TCP server. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[out]</td><td class="paramname">socket</td><td>TCP <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>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>