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

Revision:
21:17bb3eddcbae
Parent:
17:7268f365676b
Child:
26:8067e3d463d3
--- a/doc/html/classwiconnect_1_1_socket_interface.html	Sat Aug 23 05:57:52 2014 -0700
+++ b/doc/html/classwiconnect_1_1_socket_interface.html	Tue Aug 26 16:38:19 2014 -0700
@@ -134,15 +134,24 @@
 <tr class="memitem:ga037cb2813683697342fff01239c7f6f8"><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__misc.html#ga037cb2813683697342fff01239c7f6f8">connect</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;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">&#160;</td><td class="mdescRight">Connect to remote server.  <a href="group__api__socket__misc.html#ga037cb2813683697342fff01239c7f6f8">More...</a><br /></td></tr>
 <tr class="separator:ga037cb2813683697342fff01239c7f6f8"><td class="memSeparator" colspan="2">&#160;</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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__tcp.html#gafe15edec5f45f82a2ef82f0b0d5a6cb0">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=NC)</td></tr>
-<tr class="memdesc:gafe15edec5f45f82a2ef82f0b0d5a6cb0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote TCP server.  <a href="group__api__socket__tcp.html#gafe15edec5f45f82a2ef82f0b0d5a6cb0">More...</a><br /></td></tr>
-<tr class="separator:gafe15edec5f45f82a2ef82f0b0d5a6cb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:gad07bdf7931fb96d4e3210367b561afb2"><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__tls.html#gad07bdf7931fb96d4e3210367b561afb2">tlsConnect</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, const char *host, uint16_t remortPort, const char *certFilename=NULL, <a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin=NC)</td></tr>
-<tr class="memdesc:gad07bdf7931fb96d4e3210367b561afb2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote TLS server.  <a href="group__api__socket__tls.html#gad07bdf7931fb96d4e3210367b561afb2">More...</a><br /></td></tr>
-<tr class="separator:gad07bdf7931fb96d4e3210367b561afb2"><td class="memSeparator" colspan="2">&#160;</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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__udp.html#gaee37b416b1e68eaefec1b49af04c87a1">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=NC)</td></tr>
-<tr class="memdesc:gaee37b416b1e68eaefec1b49af04c87a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote UDP server.  <a href="group__api__socket__udp.html#gaee37b416b1e68eaefec1b49af04c87a1">More...</a><br /></td></tr>
-<tr class="separator:gaee37b416b1e68eaefec1b49af04c87a1"><td class="memSeparator" colspan="2">&#160;</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">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="group__api__socket__tcp.html#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">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="group__api__socket__tcp.html#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">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="group__api__socket__tcp.html#ga0ea4efc810c7c5a9fbd96fcc627633b3">More...</a><br /></td></tr>
+<tr class="separator:ga0ea4efc810c7c5a9fbd96fcc627633b3"><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">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="group__api__socket__tcp.html#ga3d0137ebe308674e75f81457c38679d0">More...</a><br /></td></tr>
+<tr class="separator:ga3d0137ebe308674e75f81457c38679d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gacf10d28ced4591d99c4113ebee6382ca"><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__tls.html#gacf10d28ced4591d99c4113ebee6382ca">tlsConnect</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, const char *host, uint16_t remortPort, const char *certFilename=NULL, <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:gacf10d28ced4591d99c4113ebee6382ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote TLS server.  <a href="group__api__socket__tls.html#gacf10d28ced4591d99c4113ebee6382ca">More...</a><br /></td></tr>
+<tr class="separator:gacf10d28ced4591d99c4113ebee6382ca"><td class="memSeparator" colspan="2">&#160;</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">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="group__api__socket__udp.html#ga80f1d19174124f3d0f246e1c1201b3ec">More...</a><br /></td></tr>
+<tr class="separator:ga80f1d19174124f3d0f246e1c1201b3ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ga181a03d883f60dff0c03b65e066f0eed"><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__http.html#ga181a03d883f60dff0c03b65e066f0eed">httpConnect</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, const char *url, const <a class="el" href="structwiconnect_1_1_http_socket_args.html">HttpSocketArgs</a> *args)</td></tr>
 <tr class="memdesc:ga181a03d883f60dff0c03b65e066f0eed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect to remote HTTP server.  <a href="group__api__socket__http.html#ga181a03d883f60dff0c03b65e066f0eed">More...</a><br /></td></tr>
 <tr class="separator:ga181a03d883f60dff0c03b65e066f0eed"><td class="memSeparator" colspan="2">&#160;</td></tr>