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__misc.html
- Revision:
- 17:7268f365676b
- Parent:
- 13:2b51f5267c92
- Child:
- 26:8067e3d463d3
--- a/doc/html/group__api__socket__misc.html Wed Aug 13 04:41:04 2014 -0700 +++ b/doc/html/group__api__socket__misc.html Sat Aug 23 05:39:17 2014 -0700 @@ -118,9 +118,9 @@ <tr class="memitem:ga820d2fdb12d343212638e55633bd8551"><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__misc.html#ga820d2fdb12d343212638e55633bd8551">wiconnect::SocketInterface::unregisterSocketIrqHandler</a> (<a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin)</td></tr> <tr class="memdesc:ga820d2fdb12d343212638e55633bd8551"><td class="mdescLeft"> </td><td class="mdescRight">Unregister a previously registered IRQ pin. <a href="#ga820d2fdb12d343212638e55633bd8551">More...</a><br /></td></tr> <tr class="separator:ga820d2fdb12d343212638e55633bd8551"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaf9a5b041736d79110a90716f1aaf9a6b"><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__misc.html#gaf9a5b041736d79110a90716f1aaf9a6b">wiconnect::SocketInterface::connect</a> (<a class="el" href="classwiconnect_1_1_socket.html">Socket</a> &socket, <a class="el" href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">SocketType</a> type, const char *host, uint16_t remortPort, uint16_t localPort, const void *args, <a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin)</td></tr> -<tr class="memdesc:gaf9a5b041736d79110a90716f1aaf9a6b"><td class="mdescLeft"> </td><td class="mdescRight">Connect to remote server. <a href="#gaf9a5b041736d79110a90716f1aaf9a6b">More...</a><br /></td></tr> -<tr class="separator:gaf9a5b041736d79110a90716f1aaf9a6b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga037cb2813683697342fff01239c7f6f8"><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__misc.html#ga037cb2813683697342fff01239c7f6f8">wiconnect::SocketInterface::connect</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &socket, <a class="el" href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">SocketType</a> type, const char *host, uint16_t remortPort, uint16_t localPort, const void *args, <a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin)</td></tr> +<tr class="memdesc:ga037cb2813683697342fff01239c7f6f8"><td class="mdescLeft"> </td><td class="mdescRight">Connect to remote server. <a href="#ga037cb2813683697342fff01239c7f6f8">More...</a><br /></td></tr> +<tr class="separator:ga037cb2813683697342fff01239c7f6f8"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>Miscellaneous socket methods. </p> @@ -139,19 +139,19 @@ </div><div class="memdoc"> <p>Close all opened sockets. </p> -<dl class="section note"><dt>Note</dt><dd>This closes all open sockets on the MODULE side. <a class="el" href="classwiconnect_1_1_socket.html" title="Connection object to remote server. ">Socket</a> objects on the HOST side will be still open until issuing a read/write command to the module using the socket handle.</dd></dl> +<dl class="section note"><dt>Note</dt><dd>This closes all open sockets on the MODULE side. Socket objects on the HOST side will be still open until issuing a read/write command to the module using the socket handle.</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="gaf9a5b041736d79110a90716f1aaf9a6b"></a> +<a class="anchor" id="ga037cb2813683697342fff01239c7f6f8"></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::connect </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> @@ -202,7 +202,7 @@ <p>This is the base method used by all the other connect methods.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> - <tr><td class="paramdir">[out]</td><td class="paramname">socket</td><td><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><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">type</td><td>The <a class="el" href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">SocketType</a> of connection to open </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">host</td><td>The host/IP address of the remote server </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">remortPort</td><td>The port of the remote server </td></tr>