ACKme
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/classwiconnect_1_1_socket_interface.html
- Revision:
- 29:b6af04b77a56
- Parent:
- 26:8067e3d463d3
diff -r 3c52f578708a -r b6af04b77a56 doc/html/classwiconnect_1_1_socket_interface.html --- a/doc/html/classwiconnect_1_1_socket_interface.html Mon Oct 27 13:32:40 2014 -0700 +++ b/doc/html/classwiconnect_1_1_socket_interface.html Mon Oct 27 13:42:26 2014 -0700 @@ -125,33 +125,30 @@ <tr class="memitem:ga8a80d96efac7cc514fe7fc61d1878106"><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#ga8a80d96efac7cc514fe7fc61d1878106">closeAllSockets</a> ()</td></tr> <tr class="memdesc:ga8a80d96efac7cc514fe7fc61d1878106"><td class="mdescLeft"> </td><td class="mdescRight">Close all opened sockets. <a href="group__api__socket__misc.html#ga8a80d96efac7cc514fe7fc61d1878106">More...</a><br /></td></tr> <tr class="separator:ga8a80d96efac7cc514fe7fc61d1878106"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga94d1eb5407cb8b60ad366ecbe0e1b52a"><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#ga94d1eb5407cb8b60ad366ecbe0e1b52a">registerSocketIrqHandler</a> (<a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin, const <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> &handler)</td></tr> -<tr class="memdesc:ga94d1eb5407cb8b60ad366ecbe0e1b52a"><td class="mdescLeft"> </td><td class="mdescRight">Register a host pin as an external interrupt. When the external interrupt is triggered, the supplied callback is executed. <a href="group__api__socket__misc.html#ga94d1eb5407cb8b60ad366ecbe0e1b52a">More...</a><br /></td></tr> -<tr class="separator:ga94d1eb5407cb8b60ad366ecbe0e1b52a"><td class="memSeparator" colspan="2"> </td></tr> -<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">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="group__api__socket__misc.html#ga820d2fdb12d343212638e55633bd8551">More...</a><br /></td></tr> -<tr class="separator:ga820d2fdb12d343212638e55633bd8551"><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">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="group__api__socket__misc.html#ga037cb2813683697342fff01239c7f6f8">More...</a><br /></td></tr> -<tr class="separator:ga037cb2813683697342fff01239c7f6f8"><td class="memSeparator" colspan="2"> </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> </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> &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"> </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"> </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> </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"> </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"> </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> </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> &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"> </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"> </td></tr> +<tr class="memitem:gab24204ef309b6e7a52b03b35a7046b45"><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#gab24204ef309b6e7a52b03b35a7046b45">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 GPIO_IRQ_ARG)</td></tr> +<tr class="memdesc:gab24204ef309b6e7a52b03b35a7046b45"><td class="mdescLeft"> </td><td class="mdescRight">Connect to remote server. <a href="group__api__socket__misc.html#gab24204ef309b6e7a52b03b35a7046b45">More...</a><br /></td></tr> +<tr class="separator:gab24204ef309b6e7a52b03b35a7046b45"><td class="memSeparator" colspan="2"> </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> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__tcp.html#gad8e8632715a38222ce4fea5fe0aaf527">tcpConnect</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &socket, const char *host, uint16_t remortPort GPIO_IRQ_ARG_NC)</td></tr> +<tr class="memdesc:gad8e8632715a38222ce4fea5fe0aaf527"><td class="mdescLeft"> </td><td class="mdescRight">Connect to remote TCP server. <a href="group__api__socket__tcp.html#gad8e8632715a38222ce4fea5fe0aaf527">More...</a><br /></td></tr> +<tr class="separator:gad8e8632715a38222ce4fea5fe0aaf527"><td class="memSeparator" colspan="2"> </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> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__tcp.html#ga9f4f3e53ea7f4e84d43529da8580aaaa">tcpListen</a> (uint16_t listeningPort, int maxClients=0 GPIO_IRQ_ARG_NC)</td></tr> +<tr class="memdesc:ga9f4f3e53ea7f4e84d43529da8580aaaa"><td class="mdescLeft"> </td><td class="mdescRight">Start internal TCP server and listen on specified port. <a href="group__api__socket__tcp.html#ga9f4f3e53ea7f4e84d43529da8580aaaa">More...</a><br /></td></tr> +<tr class="separator:ga9f4f3e53ea7f4e84d43529da8580aaaa"><td class="memSeparator" colspan="2"> </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> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__tcp.html#ga9e12bc568b7e8d72152e53a90de13035">tcpAccept</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &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"> </td><td class="mdescRight">Wait for next client to connect to TCP server. <a href="group__api__socket__tcp.html#ga9e12bc568b7e8d72152e53a90de13035">More...</a><br /></td></tr> +<tr class="separator:ga9e12bc568b7e8d72152e53a90de13035"><td class="memSeparator" colspan="2"> </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> </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"> </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"> </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> </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> &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"> </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"> </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> </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> &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"> </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"> </td></tr> +<tr class="memitem:ga4e6e89eb9aedec1ff6d25645c33f51e4"><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__tls.html#ga4e6e89eb9aedec1ff6d25645c33f51e4">tlsConnect</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &socket, const char *host, uint16_t remortPort, const char *certFilename=NULL GPIO_IRQ_ARG_NC)</td></tr> +<tr class="memdesc:ga4e6e89eb9aedec1ff6d25645c33f51e4"><td class="mdescLeft"> </td><td class="mdescRight">Connect to remote TLS server. <a href="group__api__socket__tls.html#ga4e6e89eb9aedec1ff6d25645c33f51e4">More...</a><br /></td></tr> +<tr class="separator:ga4e6e89eb9aedec1ff6d25645c33f51e4"><td class="memSeparator" colspan="2"> </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> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__udp.html#ga0ca5eabcd64ce45b574205447101f8aa">udpConnect</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &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"> </td><td class="mdescRight">Connect to remote UDP server. <a href="group__api__socket__udp.html#ga0ca5eabcd64ce45b574205447101f8aa">More...</a><br /></td></tr> +<tr class="separator:ga0ca5eabcd64ce45b574205447101f8aa"><td class="memSeparator" colspan="2"> </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> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__socket__udp.html#ga067fb0d662d8e27e3f5b561ded29a51a">udpListen</a> (<a class="el" href="classwiconnect_1_1_wiconnect_udp_server.html">WiconnectUdpServer</a> &udpServer, uint16_t listeningPort)</td></tr> +<tr class="memdesc:ga067fb0d662d8e27e3f5b561ded29a51a"><td class="mdescLeft"> </td><td class="mdescRight">Start a UDP server listening on the given port. <a href="group__api__socket__udp.html#ga067fb0d662d8e27e3f5b561ded29a51a">More...</a><br /></td></tr> +<tr class="separator:ga067fb0d662d8e27e3f5b561ded29a51a"><td class="memSeparator" colspan="2"> </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> </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> &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"> </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"> </td></tr> @@ -175,9 +172,9 @@ <div class="textblock"><p>The provides an interface for creating TCP/UDP/TLS/HTTP client sockets. A client socket connects to a remote server. </p> <dl class="section note"><dt>Note</dt><dd>This class is an interface to the <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> class. It should never be independently instantiated or the parent of another class. </dd></dl> -<p>Definition at line <a class="el" href="_socket_interface_8h_source.html#l00051">51</a> of file <a class="el" href="_socket_interface_8h_source.html">SocketInterface.h</a>.</p> +<p>Definition at line <a class="el" href="_socket_interface_8h_source.html#l00063">63</a> of file <a class="el" href="_socket_interface_8h_source.html">SocketInterface.h</a>.</p> </div><hr/>The documentation for this class was generated from the following file:<ul> -<li>C:/Users/reed/workspace/host-wiconnect/src/wiconnect/Wiconnect/<a class="el" href="_socket_interface_8h_source.html">SocketInterface.h</a></li> +<li>C:/Users/reed/workspace/host-wiconnect/src/wiconnect/Wiconnect/api/<a class="el" href="_socket_interface_8h_source.html">SocketInterface.h</a></li> </ul> </div><!-- contents --> </div><!-- doc-content -->
Repository toolbox
| Export to desktop IDE |
Repository details
| Type: | Library |
|---|---|
| Created: | 11 Aug 2014 |
| Imports: | 190 |
| Forks: | 0 |
| Commits: | 43 |
| Dependents: | 10 |
| Dependencies: | 0 |
| Followers: | 25 |
Components
AMW006-A02