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/_socket_interface_8h_source.html
- Revision:
- 16:7f1d6d359787
- Parent:
- 14:85a2ed029f37
- Child:
- 17:7268f365676b
--- a/doc/html/_socket_interface_8h_source.html Wed Aug 13 03:15:49 2014 -0700 +++ b/doc/html/_socket_interface_8h_source.html Wed Aug 13 04:41:04 2014 -0700 @@ -101,84 +101,75 @@ <div class="title">SocketInterface.h</div> </div> </div><!--header--> <div class="contents"> -<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div> -<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright 2014, ACKme Networks</span></div> -<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All Rights Reserved.</span></div> -<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div> -<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This is UNPUBLISHED PROPRIETARY SOURCE CODE of ACKme Networks;</span></div> -<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * the contents of this file may not be disclosed to third parties, copied</span></div> -<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * or duplicated in any form, in whole or in part, without the prior</span></div> -<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * written permission of ACKme Networks.</span></div> -<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> */</span></div> -<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div> -<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#pragma once</span></div> -<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div> -<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "Wiconnect.h"</span></div> -<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "types/Socket.h"</span></div> -<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include "types/SocketIrqHandlerMap.h"</span></div> -<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div> -<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div> -<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">namespace </span>wiconnect {</div> -<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div> -<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div> -<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classwiconnect_1_1_socket_interface.html"> 33</a></span> <span class="keyword">class </span><a class="code" href="classwiconnect_1_1_socket_interface.html">SocketInterface</a></div> -<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> {</div> -<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">public</span>:</div> -<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__misc.html#ga8a80d96efac7cc514fe7fc61d1878106">closeAllSockets</a>();</div> -<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div> -<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__misc.html#ga94d1eb5407cb8b60ad366ecbe0e1b52a">registerSocketIrqHandler</a>(<a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin, <span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_callback.html">Callback</a> &handler);</div> -<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div> -<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__misc.html#ga820d2fdb12d343212638e55633bd8551">unregisterSocketIrqHandler</a>(<a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin);</div> -<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div> -<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div> -<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__misc.html#gaf9a5b041736d79110a90716f1aaf9a6b">connect</a>(<a class="code" href="classwiconnect_1_1_socket.html">Socket</a> &socket, <a class="code" href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">SocketType</a> type, <span class="keyword">const</span> <span class="keywordtype">char</span> *host, uint16_t remortPort, uint16_t localPort, <span class="keyword">const</span> <span class="keywordtype">void</span> *args, <a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin);</div> +<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div> +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#pragma once</span></div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div> +<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "Wiconnect.h"</span></div> +<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "types/Socket.h"</span></div> +<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include "types/SocketIrqHandlerMap.h"</span></div> +<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">namespace </span>wiconnect {</div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div> +<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div> +<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classwiconnect_1_1_socket_interface.html"> 51</a></span> <span class="keyword">class </span><a class="code" href="classwiconnect_1_1_socket_interface.html">SocketInterface</a></div> +<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> {</div> +<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">public</span>:</div> +<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__misc.html#ga8a80d96efac7cc514fe7fc61d1878106">closeAllSockets</a>();</div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div> +<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__misc.html#ga94d1eb5407cb8b60ad366ecbe0e1b52a">registerSocketIrqHandler</a>(<a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin, <span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_callback.html">Callback</a> &handler);</div> +<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div> +<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__misc.html#ga820d2fdb12d343212638e55633bd8551">unregisterSocketIrqHandler</a>(<a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin);</div> +<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div> -<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div> -<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="comment">// ------------------------------------------------------------------------</span></div> -<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div> -<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__tcp.html#ga74f8ac6b81d3b96a26411b4faffc6a01">tcpConnect</a>(<a class="code" href="classwiconnect_1_1_socket.html">Socket</a> &socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *host, uint16_t remortPort, <a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin = NC);</div> -<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div> -<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div> -<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="comment">// ------------------------------------------------------------------------</span></div> +<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__misc.html#gaf9a5b041736d79110a90716f1aaf9a6b">connect</a>(<a class="code" href="classwiconnect_1_1_socket.html">Socket</a> &socket, <a class="code" href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">SocketType</a> type, <span class="keyword">const</span> <span class="keywordtype">char</span> *host, uint16_t remortPort, uint16_t localPort, <span class="keyword">const</span> <span class="keywordtype">void</span> *args, <a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin);</div> +<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div> <div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div> -<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__tls.html#ga559cb4c055639a83fce560693dff4870">tlsConnect</a>(<a class="code" href="classwiconnect_1_1_socket.html">Socket</a> &socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *host, uint16_t remortPort, <span class="keyword">const</span> <span class="keywordtype">char</span> *certFilename = NULL, <a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin = NC);</div> -<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div> +<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="comment">// ------------------------------------------------------------------------</span></div> +<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div> +<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__tcp.html#ga74f8ac6b81d3b96a26411b4faffc6a01">tcpConnect</a>(<a class="code" href="classwiconnect_1_1_socket.html">Socket</a> &socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *host, uint16_t remortPort, <a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin = NC);</div> <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div> -<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="comment">// ------------------------------------------------------------------------</span></div> -<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div> -<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__udp.html#ga1a7ee47642c572db433e68eaee65c44c">udpConnect</a>(<a class="code" href="classwiconnect_1_1_socket.html">Socket</a> &socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *host, uint16_t remortPort, uint16_t localPort = <a class="code" href="group__api__socket__macro.html#gae54117ebe433295ef992b9ca83c46d98">SOCKET_ANY_PORT</a>, <a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin = NC);</div> -<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div> +<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div> +<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="comment">// ------------------------------------------------------------------------</span></div> +<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div> +<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__tls.html#ga559cb4c055639a83fce560693dff4870">tlsConnect</a>(<a class="code" href="classwiconnect_1_1_socket.html">Socket</a> &socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *host, uint16_t remortPort, <span class="keyword">const</span> <span class="keywordtype">char</span> *certFilename = NULL, <a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin = NC);</div> <div class="line"><a name="l00159"></a><span class="lineno"> 159</span> </div> -<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="comment">// ------------------------------------------------------------------------</span></div> -<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div> -<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__http.html#gab2d562c96f8f40d916fc1df1229f0e09">httpConnect</a>(<a class="code" href="classwiconnect_1_1_socket.html">Socket</a> &socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *url, <span class="keyword">const</span> <a class="code" href="structwiconnect_1_1_http_socket_args.html">HttpSocketArgs</a> *args);</div> -<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div> -<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__http.html#ga818f9fc3d616deb5ac009f001e5e611b">httpGet</a>(<a class="code" href="classwiconnect_1_1_socket.html">Socket</a> &socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *url, <span class="keywordtype">bool</span> openOnly = <span class="keyword">false</span>, <span class="keyword">const</span> <span class="keywordtype">char</span> *certFilename = NULL);</div> -<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> </div> -<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__http.html#gaaa5cb3c4b27ed0f2002e81392606a756">httpPost</a>(<a class="code" href="classwiconnect_1_1_socket.html">Socket</a> &socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *url, <span class="keyword">const</span> <span class="keywordtype">char</span> *contextType, <span class="keywordtype">bool</span> openOnly = <span class="keyword">true</span>, <span class="keyword">const</span> <span class="keywordtype">char</span> *certFilename = NULL);</div> -<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> </div> -<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__http.html#ga949cee4543c91951219652bd6282049f">httpHead</a>(<a class="code" href="classwiconnect_1_1_socket.html">Socket</a> &socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *url, <span class="keyword">const</span> <span class="keywordtype">char</span> *certFilename = NULL);</div> -<div class="line"><a name="l00236"></a><span class="lineno"> 236</span> </div> -<div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__http.html#ga2b3fd9a84f173312318e2bb22cef2004">httpAddHeader</a>(<a class="code" href="classwiconnect_1_1_socket.html">Socket</a> &socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *key, <span class="keyword">const</span> <span class="keywordtype">char</span> *value);</div> -<div class="line"><a name="l00255"></a><span class="lineno"> 255</span> </div> -<div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__http.html#ga0cad302f741f3f58a2fda54b67110a70">httpGetStatus</a>(<a class="code" href="classwiconnect_1_1_socket.html">Socket</a> &socket, uint32_t *statusCodePtr);</div> -<div class="line"><a name="l00269"></a><span class="lineno"> 269</span> </div> -<div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="keyword">protected</span>:</div> -<div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  <a class="code" href="classwiconnect_1_1_socket_interface.html">SocketInterface</a>(<a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> *wiconnect);</div> -<div class="line"><a name="l00272"></a><span class="lineno"> 272</span> </div> -<div class="line"><a name="l00273"></a><span class="lineno"> 273</span>  SocketIrqHandlerMap irqHandlers;</div> -<div class="line"><a name="l00274"></a><span class="lineno"> 274</span> </div> -<div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="keyword">private</span>:</div> -<div class="line"><a name="l00276"></a><span class="lineno"> 276</span>  <a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> *wiconnect;</div> -<div class="line"><a name="l00277"></a><span class="lineno"> 277</span> };</div> -<div class="line"><a name="l00278"></a><span class="lineno"> 278</span> </div> -<div class="line"><a name="l00279"></a><span class="lineno"> 279</span> }</div> -<div class="ttc" id="group__api__socket__types_html_ga69dc55558df4c81599c5fb3dff98756d"><div class="ttname"><a href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">wiconnect::SocketType</a></div><div class="ttdeci">SocketType</div><div class="ttdoc">Socket type. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00274">WiconnectTypes.h:274</a></div></div> +<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div> +<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="comment">// ------------------------------------------------------------------------</span></div> +<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div> +<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__udp.html#ga1a7ee47642c572db433e68eaee65c44c">udpConnect</a>(<a class="code" href="classwiconnect_1_1_socket.html">Socket</a> &socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *host, uint16_t remortPort, uint16_t localPort = <a class="code" href="group__api__socket__macro.html#gae54117ebe433295ef992b9ca83c46d98">SOCKET_ANY_PORT</a>, <a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin = NC);</div> +<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div> +<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> </div> +<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <span class="comment">// ------------------------------------------------------------------------</span></div> +<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> </div> +<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__http.html#gab2d562c96f8f40d916fc1df1229f0e09">httpConnect</a>(<a class="code" href="classwiconnect_1_1_socket.html">Socket</a> &socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *url, <span class="keyword">const</span> <a class="code" href="structwiconnect_1_1_http_socket_args.html">HttpSocketArgs</a> *args);</div> +<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> </div> +<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__http.html#ga818f9fc3d616deb5ac009f001e5e611b">httpGet</a>(<a class="code" href="classwiconnect_1_1_socket.html">Socket</a> &socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *url, <span class="keywordtype">bool</span> openOnly = <span class="keyword">false</span>, <span class="keyword">const</span> <span class="keywordtype">char</span> *certFilename = NULL);</div> +<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> </div> +<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__http.html#gaaa5cb3c4b27ed0f2002e81392606a756">httpPost</a>(<a class="code" href="classwiconnect_1_1_socket.html">Socket</a> &socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *url, <span class="keyword">const</span> <span class="keywordtype">char</span> *contextType, <span class="keywordtype">bool</span> openOnly = <span class="keyword">true</span>, <span class="keyword">const</span> <span class="keywordtype">char</span> *certFilename = NULL);</div> +<div class="line"><a name="l00242"></a><span class="lineno"> 242</span> </div> +<div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__http.html#ga949cee4543c91951219652bd6282049f">httpHead</a>(<a class="code" href="classwiconnect_1_1_socket.html">Socket</a> &socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *url, <span class="keyword">const</span> <span class="keywordtype">char</span> *certFilename = NULL);</div> +<div class="line"><a name="l00254"></a><span class="lineno"> 254</span> </div> +<div class="line"><a name="l00272"></a><span class="lineno"> 272</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__http.html#ga2b3fd9a84f173312318e2bb22cef2004">httpAddHeader</a>(<a class="code" href="classwiconnect_1_1_socket.html">Socket</a> &socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *key, <span class="keyword">const</span> <span class="keywordtype">char</span> *value);</div> +<div class="line"><a name="l00273"></a><span class="lineno"> 273</span> </div> +<div class="line"><a name="l00286"></a><span class="lineno"> 286</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__http.html#ga0cad302f741f3f58a2fda54b67110a70">httpGetStatus</a>(<a class="code" href="classwiconnect_1_1_socket.html">Socket</a> &socket, uint32_t *statusCodePtr);</div> +<div class="line"><a name="l00287"></a><span class="lineno"> 287</span> </div> +<div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="keyword">protected</span>:</div> +<div class="line"><a name="l00289"></a><span class="lineno"> 289</span>  <a class="code" href="classwiconnect_1_1_socket_interface.html">SocketInterface</a>(<a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> *wiconnect);</div> +<div class="line"><a name="l00290"></a><span class="lineno"> 290</span> </div> +<div class="line"><a name="l00291"></a><span class="lineno"> 291</span>  SocketIrqHandlerMap irqHandlers;</div> +<div class="line"><a name="l00292"></a><span class="lineno"> 292</span> </div> +<div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="keyword">private</span>:</div> +<div class="line"><a name="l00294"></a><span class="lineno"> 294</span>  <a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> *wiconnect;</div> +<div class="line"><a name="l00295"></a><span class="lineno"> 295</span> };</div> +<div class="line"><a name="l00296"></a><span class="lineno"> 296</span> </div> +<div class="line"><a name="l00297"></a><span class="lineno"> 297</span> }</div> +<div class="ttc" id="group__api__socket__types_html_ga69dc55558df4c81599c5fb3dff98756d"><div class="ttname"><a href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">wiconnect::SocketType</a></div><div class="ttdeci">SocketType</div><div class="ttdoc">Socket type. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00292">WiconnectTypes.h:292</a></div></div> <div class="ttc" id="group__api__socket__http_html_ga0cad302f741f3f58a2fda54b67110a70"><div class="ttname"><a href="group__api__socket__http.html#ga0cad302f741f3f58a2fda54b67110a70">wiconnect::SocketInterface::httpGetStatus</a></div><div class="ttdeci">WiconnectResult httpGetStatus(Socket &socket, uint32_t *statusCodePtr)</div><div class="ttdoc">Get the HTTP status code from HTTP request. </div></div> <div class="ttc" id="group__api__socket__udp_html_ga1a7ee47642c572db433e68eaee65c44c"><div class="ttname"><a href="group__api__socket__udp.html#ga1a7ee47642c572db433e68eaee65c44c">wiconnect::SocketInterface::udpConnect</a></div><div class="ttdeci">WiconnectResult udpConnect(Socket &socket, const char *host, uint16_t remortPort, uint16_t localPort=SOCKET_ANY_PORT, Pin irqPin=NC)</div><div class="ttdoc">Connect to remote UDP server. </div></div> -<div class="ttc" id="group__api__core__types_html_ga325637ed501728bd6c8c7a7982b9ce05"><div class="ttname"><a href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">wiconnect::WiconnectResult</a></div><div class="ttdeci">WiconnectResult</div><div class="ttdoc">API Result code. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00127">WiconnectTypes.h:127</a></div></div> +<div class="ttc" id="group__api__core__types_html_ga325637ed501728bd6c8c7a7982b9ce05"><div class="ttname"><a href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">wiconnect::WiconnectResult</a></div><div class="ttdeci">WiconnectResult</div><div class="ttdoc">API Result code. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00145">WiconnectTypes.h:145</a></div></div> <div class="ttc" id="group__api__socket__http_html_ga2b3fd9a84f173312318e2bb22cef2004"><div class="ttname"><a href="group__api__socket__http.html#ga2b3fd9a84f173312318e2bb22cef2004">wiconnect::SocketInterface::httpAddHeader</a></div><div class="ttdeci">WiconnectResult httpAddHeader(Socket &socket, const char *key, const char *value)</div><div class="ttdoc">Add HTTP header key/value pair to opened HTTP request. </div></div> -<div class="ttc" id="classwiconnect_1_1_callback_html"><div class="ttname"><a href="classwiconnect_1_1_callback.html">wiconnect::Callback</a></div><div class="ttdoc">Generic callback function. </div><div class="ttdef"><b>Definition:</b> <a href="_callback_8h_source.html#l00031">Callback.h:31</a></div></div> +<div class="ttc" id="classwiconnect_1_1_callback_html"><div class="ttname"><a href="classwiconnect_1_1_callback.html">wiconnect::Callback</a></div><div class="ttdoc">Generic callback function. </div><div class="ttdef"><b>Definition:</b> <a href="_callback_8h_source.html#l00049">Callback.h:49</a></div></div> <div class="ttc" id="group__api__socket__misc_html_ga94d1eb5407cb8b60ad366ecbe0e1b52a"><div class="ttname"><a href="group__api__socket__misc.html#ga94d1eb5407cb8b60ad366ecbe0e1b52a">wiconnect::SocketInterface::registerSocketIrqHandler</a></div><div class="ttdeci">WiconnectResult registerSocketIrqHandler(Pin irqPin, const Callback &handler)</div><div class="ttdoc">Register a host pin as an external interrupt. When the external interrupt is triggered, the supplied callback is executed. </div></div> <div class="ttc" id="group__api__socket__misc_html_ga820d2fdb12d343212638e55633bd8551"><div class="ttname"><a href="group__api__socket__misc.html#ga820d2fdb12d343212638e55633bd8551">wiconnect::SocketInterface::unregisterSocketIrqHandler</a></div><div class="ttdeci">WiconnectResult unregisterSocketIrqHandler(Pin irqPin)</div><div class="ttdoc">Unregister a previously registered IRQ pin. </div></div> <div class="ttc" id="group__api__socket__misc_html_gaf9a5b041736d79110a90716f1aaf9a6b"><div class="ttname"><a href="group__api__socket__misc.html#gaf9a5b041736d79110a90716f1aaf9a6b">wiconnect::SocketInterface::connect</a></div><div class="ttdeci">WiconnectResult connect(Socket &socket, SocketType type, const char *host, uint16_t remortPort, uint16_t localPort, const void *args, Pin irqPin)</div><div class="ttdoc">Connect to remote server. </div></div> @@ -186,15 +177,15 @@ <div class="ttc" id="group__api__socket__http_html_gab2d562c96f8f40d916fc1df1229f0e09"><div class="ttname"><a href="group__api__socket__http.html#gab2d562c96f8f40d916fc1df1229f0e09">wiconnect::SocketInterface::httpConnect</a></div><div class="ttdeci">WiconnectResult httpConnect(Socket &socket, const char *url, const HttpSocketArgs *args)</div><div class="ttdoc">Connect to remote HTTP server. </div></div> <div class="ttc" id="group__api__socket__http_html_gaaa5cb3c4b27ed0f2002e81392606a756"><div class="ttname"><a href="group__api__socket__http.html#gaaa5cb3c4b27ed0f2002e81392606a756">wiconnect::SocketInterface::httpPost</a></div><div class="ttdeci">WiconnectResult httpPost(Socket &socket, const char *url, const char *contextType, bool openOnly=true, const char *certFilename=NULL)</div><div class="ttdoc">Issue HTTP POST Request. </div></div> <div class="ttc" id="group__api__socket__http_html_ga949cee4543c91951219652bd6282049f"><div class="ttname"><a href="group__api__socket__http.html#ga949cee4543c91951219652bd6282049f">wiconnect::SocketInterface::httpHead</a></div><div class="ttdeci">WiconnectResult httpHead(Socket &socket, const char *url, const char *certFilename=NULL)</div><div class="ttdoc">Issue HTTP HEAD Request. </div></div> -<div class="ttc" id="group__api__socket__macro_html_gae54117ebe433295ef992b9ca83c46d98"><div class="ttname"><a href="group__api__socket__macro.html#gae54117ebe433295ef992b9ca83c46d98">SOCKET_ANY_PORT</a></div><div class="ttdeci">#define SOCKET_ANY_PORT</div><div class="ttdoc">Default which indicates to use the most optimal port. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00115">WiconnectTypes.h:115</a></div></div> +<div class="ttc" id="group__api__socket__macro_html_gae54117ebe433295ef992b9ca83c46d98"><div class="ttname"><a href="group__api__socket__macro.html#gae54117ebe433295ef992b9ca83c46d98">SOCKET_ANY_PORT</a></div><div class="ttdeci">#define SOCKET_ANY_PORT</div><div class="ttdoc">Default which indicates to use the most optimal port. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00133">WiconnectTypes.h:133</a></div></div> <div class="ttc" id="group__api__socket__misc_html_ga8a80d96efac7cc514fe7fc61d1878106"><div class="ttname"><a href="group__api__socket__misc.html#ga8a80d96efac7cc514fe7fc61d1878106">wiconnect::SocketInterface::closeAllSockets</a></div><div class="ttdeci">WiconnectResult closeAllSockets()</div><div class="ttdoc">Close all opened sockets. </div></div> -<div class="ttc" id="group__api__core__types_html_ga1cf4dfa71da0b0dc3dc707dacf56cc9c"><div class="ttname"><a href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">wiconnect::Pin</a></div><div class="ttdeci">PinName Pin</div><div class="ttdoc">Pin name on HOST. </div><div class="ttdef"><b>Definition:</b> <a href="sdk_8h_source.html#l00102">sdk.h:102</a></div></div> +<div class="ttc" id="group__api__core__types_html_ga1cf4dfa71da0b0dc3dc707dacf56cc9c"><div class="ttname"><a href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">wiconnect::Pin</a></div><div class="ttdeci">PinName Pin</div><div class="ttdoc">Pin name on HOST. </div><div class="ttdef"><b>Definition:</b> <a href="sdk_8h_source.html#l00120">sdk.h:120</a></div></div> <div class="ttc" id="group__api__socket__tls_html_ga559cb4c055639a83fce560693dff4870"><div class="ttname"><a href="group__api__socket__tls.html#ga559cb4c055639a83fce560693dff4870">wiconnect::SocketInterface::tlsConnect</a></div><div class="ttdeci">WiconnectResult tlsConnect(Socket &socket, const char *host, uint16_t remortPort, const char *certFilename=NULL, Pin irqPin=NC)</div><div class="ttdoc">Connect to remote TLS server. </div></div> -<div class="ttc" id="classwiconnect_1_1_socket_html"><div class="ttname"><a href="classwiconnect_1_1_socket.html">wiconnect::Socket</a></div><div class="ttdoc">Connection object to remote server. </div><div class="ttdef"><b>Definition:</b> <a href="_socket_8h_source.html#l00025">Socket.h:25</a></div></div> +<div class="ttc" id="classwiconnect_1_1_socket_html"><div class="ttname"><a href="classwiconnect_1_1_socket.html">wiconnect::Socket</a></div><div class="ttdoc">Connection object to remote server. </div><div class="ttdef"><b>Definition:</b> <a href="_socket_8h_source.html#l00043">Socket.h:43</a></div></div> <div class="ttc" id="group__api__socket__tcp_html_ga74f8ac6b81d3b96a26411b4faffc6a01"><div class="ttname"><a href="group__api__socket__tcp.html#ga74f8ac6b81d3b96a26411b4faffc6a01">wiconnect::SocketInterface::tcpConnect</a></div><div class="ttdeci">WiconnectResult tcpConnect(Socket &socket, const char *host, uint16_t remortPort, Pin irqPin=NC)</div><div class="ttdoc">Connect to remote TCP server. </div></div> -<div class="ttc" id="classwiconnect_1_1_socket_interface_html"><div class="ttname"><a href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a></div><div class="ttdoc">The provides an interface for creating TCP/UDP/TLS/HTTP client sockets. A client socket connects to a...</div><div class="ttdef"><b>Definition:</b> <a href="_socket_interface_8h_source.html#l00033">SocketInterface.h:33</a></div></div> -<div class="ttc" id="classwiconnect_1_1_wiconnect_html"><div class="ttname"><a href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></div><div class="ttdoc">The root WiConnect library class. This class inheriets all WiConnect functionality. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_interface_8h_source.html#l00056">WiconnectInterface.h:56</a></div></div> -<div class="ttc" id="structwiconnect_1_1_http_socket_args_html"><div class="ttname"><a href="structwiconnect_1_1_http_socket_args.html">wiconnect::HttpSocketArgs</a></div><div class="ttdoc">Struct for hold HTTP socket configuration. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00298">WiconnectTypes.h:298</a></div></div> +<div class="ttc" id="classwiconnect_1_1_socket_interface_html"><div class="ttname"><a href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a></div><div class="ttdoc">The provides an interface for creating TCP/UDP/TLS/HTTP client sockets. A client socket connects to a...</div><div class="ttdef"><b>Definition:</b> <a href="_socket_interface_8h_source.html#l00051">SocketInterface.h:51</a></div></div> +<div class="ttc" id="classwiconnect_1_1_wiconnect_html"><div class="ttname"><a href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></div><div class="ttdoc">The root WiConnect library class. This class inheriets all WiConnect functionality. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_interface_8h_source.html#l00074">WiconnectInterface.h:74</a></div></div> +<div class="ttc" id="structwiconnect_1_1_http_socket_args_html"><div class="ttname"><a href="structwiconnect_1_1_http_socket_args.html">wiconnect::HttpSocketArgs</a></div><div class="ttdoc">Struct for hold HTTP socket configuration. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00316">WiconnectTypes.h:316</a></div></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->