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/_socket_interface_8h_source.html
- Revision:
- 21:17bb3eddcbae
- Parent:
- 17:7268f365676b
- Child:
- 26:8067e3d463d3
--- a/doc/html/_socket_interface_8h_source.html Sat Aug 23 05:57:52 2014 -0700 +++ b/doc/html/_socket_interface_8h_source.html Tue Aug 26 16:38:19 2014 -0700 @@ -127,64 +127,92 @@ <div class="line"><a name="l00127"></a><span class="lineno"> 127</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#gafe15edec5f45f82a2ef82f0b0d5a6cb0">tcpConnect</a>(<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</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="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#ga4a788d604d759b5da51f682b998b9bd2">tcpConnect</a>(<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</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 = <a class="code" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>);</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> </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#gad07bdf7931fb96d4e3210367b561afb2">tlsConnect</a>(<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</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="l00156"></a><span class="lineno"> 156</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__tcp.html#ga563831b33089437233f128483d034578">tcpListen</a>(uint16_t listeningPort, <span class="keywordtype">int</span> maxClients = 0, <a class="code" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> irqPin = <a class="code" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>);</div> +<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div> +<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div> +<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="comment">// ------------------------------------------------------------------------</span></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#gaee37b416b1e68eaefec1b49af04c87a1">udpConnect</a>(<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</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#ga181a03d883f60dff0c03b65e066f0eed">httpConnect</a>(<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</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="l00170"></a><span class="lineno"> 170</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__tcp.html#ga0ea4efc810c7c5a9fbd96fcc627633b3">tcpAccept</a>(<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &socket, <span class="keywordtype">int</span> timeoutMs = <a class="code" href="group__api__core__macro.html#ga580e5f45fee866c845e0d3fd1eb1744a">WICONNECT_WAIT_FOREVER</a>);</div> +<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div> +<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div> +<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <span class="comment">// ------------------------------------------------------------------------</span></div> +<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> </div> +<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__tcp.html#ga3d0137ebe308674e75f81457c38679d0">tcpServerStop</a>(<span class="keywordtype">void</span>);</div> +<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> </div> +<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> </div> +<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <span class="comment">// ------------------------------------------------------------------------</span></div> +<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> </div> +<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__tls.html#gacf10d28ced4591d99c4113ebee6382ca">tlsConnect</a>(<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</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 = <a class="code" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>);</div> +<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> </div> +<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> </div> +<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  <span class="comment">// ------------------------------------------------------------------------</span></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#gac9b6c6a348f790cc8d43889dd72029f6">httpGet</a>(<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</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#ga1b6a3ebdbd164f0eb683fc335ef4d365">httpPost</a>(<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</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#gabcb3d69b2b1718e7ebe1ed171dec1f85">httpHead</a>(<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</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#gabed18edc44f464bac64ce8a6dc3617ec">httpAddHeader</a>(<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</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#gadf59ca0783b89ee32f205e33f1bd5517">httpGetStatus</a>(<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</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#l00293">WiconnectTypes.h:293</a></div></div> -<div class="ttc" id="group__api__socket__udp_html_gaee37b416b1e68eaefec1b49af04c87a1"><div class="ttname"><a href="group__api__socket__udp.html#gaee37b416b1e68eaefec1b49af04c87a1">wiconnect::SocketInterface::udpConnect</a></div><div class="ttdeci">WiconnectResult udpConnect(WiconnectSocket &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="line"><a name="l00216"></a><span class="lineno"> 216</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__udp.html#ga80f1d19174124f3d0f246e1c1201b3ec">udpConnect</a>(<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</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 = <a class="code" href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a>);</div> +<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> </div> +<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> </div> +<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  <span class="comment">// ------------------------------------------------------------------------</span></div> +<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> </div> +<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__http.html#ga181a03d883f60dff0c03b65e066f0eed">httpConnect</a>(<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</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="l00244"></a><span class="lineno"> 244</span> </div> +<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__http.html#gac9b6c6a348f790cc8d43889dd72029f6">httpGet</a>(<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</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="l00263"></a><span class="lineno"> 263</span> </div> +<div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__http.html#ga1b6a3ebdbd164f0eb683fc335ef4d365">httpPost</a>(<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</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="l00283"></a><span class="lineno"> 283</span> </div> +<div class="line"><a name="l00294"></a><span class="lineno"> 294</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__http.html#gabcb3d69b2b1718e7ebe1ed171dec1f85">httpHead</a>(<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</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="l00295"></a><span class="lineno"> 295</span> </div> +<div class="line"><a name="l00313"></a><span class="lineno"> 313</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__http.html#gabed18edc44f464bac64ce8a6dc3617ec">httpAddHeader</a>(<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</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="l00314"></a><span class="lineno"> 314</span> </div> +<div class="line"><a name="l00327"></a><span class="lineno"> 327</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> <a class="code" href="group__api__socket__http.html#gadf59ca0783b89ee32f205e33f1bd5517">httpGetStatus</a>(<a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &socket, uint32_t *statusCodePtr);</div> +<div class="line"><a name="l00328"></a><span class="lineno"> 328</span> </div> +<div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="keyword">protected</span>:</div> +<div class="line"><a name="l00330"></a><span class="lineno"> 330</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="l00331"></a><span class="lineno"> 331</span>  ~<a class="code" href="classwiconnect_1_1_socket_interface.html">SocketInterface</a>();</div> +<div class="line"><a name="l00332"></a><span class="lineno"> 332</span> </div> +<div class="line"><a name="l00333"></a><span class="lineno"> 333</span>  SocketIrqHandlerMap irqHandlers;</div> +<div class="line"><a name="l00334"></a><span class="lineno"> 334</span> </div> +<div class="line"><a name="l00335"></a><span class="lineno"> 335</span>  <span class="keywordtype">bool</span> serverConnectedClientList[<a class="code" href="group__api__core__macro.html#ga45fe565132845ca570ded816f25561b0">WICONNECT_MAX_SOCKETS</a>];</div> +<div class="line"><a name="l00336"></a><span class="lineno"> 336</span> </div> +<div class="line"><a name="l00337"></a><span class="lineno"> 337</span>  <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> pollForServerClient(uint8_t *handle = NULL, uint16_t *localPort = NULL, uint16_t *remotePort = NULL, uint32_t *ipAddress = NULL);</div> +<div class="line"><a name="l00338"></a><span class="lineno"> 338</span> </div> +<div class="line"><a name="l00339"></a><span class="lineno"> 339</span>  <span class="keywordtype">void</span> socketClosedCallback(<span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> *socket);</div> +<div class="line"><a name="l00340"></a><span class="lineno"> 340</span> </div> +<div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="keyword">private</span>:</div> +<div class="line"><a name="l00342"></a><span class="lineno"> 342</span>  <a class="code" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> *wiconnect;</div> +<div class="line"><a name="l00343"></a><span class="lineno"> 343</span> };</div> +<div class="line"><a name="l00344"></a><span class="lineno"> 344</span> </div> +<div class="line"><a name="l00345"></a><span class="lineno"> 345</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#l00302">WiconnectTypes.h:302</a></div></div> <div class="ttc" id="group__api__socket__http_html_ga1b6a3ebdbd164f0eb683fc335ef4d365"><div class="ttname"><a href="group__api__socket__http.html#ga1b6a3ebdbd164f0eb683fc335ef4d365">wiconnect::SocketInterface::httpPost</a></div><div class="ttdeci">WiconnectResult httpPost(WiconnectSocket &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__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#l00146">WiconnectTypes.h:146</a></div></div> +<div class="ttc" id="group__api__socket__udp_html_ga80f1d19174124f3d0f246e1c1201b3ec"><div class="ttname"><a href="group__api__socket__udp.html#ga80f1d19174124f3d0f246e1c1201b3ec">wiconnect::SocketInterface::udpConnect</a></div><div class="ttdeci">WiconnectResult udpConnect(WiconnectSocket &socket, const char *host, uint16_t remortPort, uint16_t localPort=SOCKET_ANY_PORT, Pin irqPin=PIN_NC)</div><div class="ttdoc">Connect to remote UDP server. </div></div> +<div class="ttc" id="group__api__socket__tls_html_gacf10d28ced4591d99c4113ebee6382ca"><div class="ttname"><a href="group__api__socket__tls.html#gacf10d28ced4591d99c4113ebee6382ca">wiconnect::SocketInterface::tlsConnect</a></div><div class="ttdeci">WiconnectResult tlsConnect(WiconnectSocket &socket, const char *host, uint16_t remortPort, const char *certFilename=NULL, Pin irqPin=PIN_NC)</div><div class="ttdoc">Connect to remote TLS 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#l00155">WiconnectTypes.h:155</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__core__macro_html_ga45fe565132845ca570ded816f25561b0"><div class="ttname"><a href="group__api__core__macro.html#ga45fe565132845ca570ded816f25561b0">WICONNECT_MAX_SOCKETS</a></div><div class="ttdeci">#define WICONNECT_MAX_SOCKETS</div><div class="ttdoc">The maximum number of simulanteous opened sockets. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00116">WiconnectTypes.h:116</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__tls_html_gad07bdf7931fb96d4e3210367b561afb2"><div class="ttname"><a href="group__api__socket__tls.html#gad07bdf7931fb96d4e3210367b561afb2">wiconnect::SocketInterface::tlsConnect</a></div><div class="ttdeci">WiconnectResult tlsConnect(WiconnectSocket &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="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#l00134">WiconnectTypes.h:134</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#l00143">WiconnectTypes.h:143</a></div></div> <div class="ttc" id="group__api__socket__http_html_gabed18edc44f464bac64ce8a6dc3617ec"><div class="ttname"><a href="group__api__socket__http.html#gabed18edc44f464bac64ce8a6dc3617ec">wiconnect::SocketInterface::httpAddHeader</a></div><div class="ttdeci">WiconnectResult httpAddHeader(WiconnectSocket &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="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__socket__http_html_ga181a03d883f60dff0c03b65e066f0eed"><div class="ttname"><a href="group__api__socket__http.html#ga181a03d883f60dff0c03b65e066f0eed">wiconnect::SocketInterface::httpConnect</a></div><div class="ttdeci">WiconnectResult httpConnect(WiconnectSocket &socket, const char *url, const HttpSocketArgs *args)</div><div class="ttdoc">Connect to remote HTTP server. </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#l00123">sdk.h:123</a></div></div> -<div class="ttc" id="group__api__socket__tcp_html_gafe15edec5f45f82a2ef82f0b0d5a6cb0"><div class="ttname"><a href="group__api__socket__tcp.html#gafe15edec5f45f82a2ef82f0b0d5a6cb0">wiconnect::SocketInterface::tcpConnect</a></div><div class="ttdeci">WiconnectResult tcpConnect(WiconnectSocket &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="group__api__socket__http_html_gac9b6c6a348f790cc8d43889dd72029f6"><div class="ttname"><a href="group__api__socket__http.html#gac9b6c6a348f790cc8d43889dd72029f6">wiconnect::SocketInterface::httpGet</a></div><div class="ttdeci">WiconnectResult httpGet(WiconnectSocket &socket, const char *url, bool openOnly=false, const char *certFilename=NULL)</div><div class="ttdoc">Issue HTTP GET Request. </div></div> +<div class="ttc" id="group__api__socket__tcp_html_ga0ea4efc810c7c5a9fbd96fcc627633b3"><div class="ttname"><a href="group__api__socket__tcp.html#ga0ea4efc810c7c5a9fbd96fcc627633b3">wiconnect::SocketInterface::tcpAccept</a></div><div class="ttdeci">WiconnectResult tcpAccept(WiconnectSocket &socket, int timeoutMs=WICONNECT_WAIT_FOREVER)</div><div class="ttdoc">Wait for next client to connect to TCP server. </div></div> <div class="ttc" id="group__api__socket__http_html_gabcb3d69b2b1718e7ebe1ed171dec1f85"><div class="ttname"><a href="group__api__socket__http.html#gabcb3d69b2b1718e7ebe1ed171dec1f85">wiconnect::SocketInterface::httpHead</a></div><div class="ttdeci">WiconnectResult httpHead(WiconnectSocket &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__tcp_html_ga4a788d604d759b5da51f682b998b9bd2"><div class="ttname"><a href="group__api__socket__tcp.html#ga4a788d604d759b5da51f682b998b9bd2">wiconnect::SocketInterface::tcpConnect</a></div><div class="ttdeci">WiconnectResult tcpConnect(WiconnectSocket &socket, const char *host, uint16_t remortPort, Pin irqPin=PIN_NC)</div><div class="ttdoc">Connect to remote TCP server. </div></div> <div class="ttc" id="classwiconnect_1_1_wiconnect_socket_html"><div class="ttname"><a href="classwiconnect_1_1_wiconnect_socket.html">wiconnect::WiconnectSocket</a></div><div class="ttdoc">Connection object to remote server. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_socket_8h_source.html#l00043">WiconnectSocket.h:43</a></div></div> +<div class="ttc" id="group__api__core__macro_html_ga580e5f45fee866c845e0d3fd1eb1744a"><div class="ttname"><a href="group__api__core__macro.html#ga580e5f45fee866c845e0d3fd1eb1744a">WICONNECT_WAIT_FOREVER</a></div><div class="ttdeci">#define WICONNECT_WAIT_FOREVER</div><div class="ttdoc">Never timeout. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00131">WiconnectTypes.h:131</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="group__api__socket__tcp_html_ga3d0137ebe308674e75f81457c38679d0"><div class="ttname"><a href="group__api__socket__tcp.html#ga3d0137ebe308674e75f81457c38679d0">wiconnect::SocketInterface::tcpServerStop</a></div><div class="ttdeci">WiconnectResult tcpServerStop(void)</div><div class="ttdoc">Stop TCP server from listening on port. Close all connected clients. </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="group__api__socket__tcp_html_ga563831b33089437233f128483d034578"><div class="ttname"><a href="group__api__socket__tcp.html#ga563831b33089437233f128483d034578">wiconnect::SocketInterface::tcpListen</a></div><div class="ttdeci">WiconnectResult tcpListen(uint16_t listeningPort, int maxClients=0, Pin irqPin=PIN_NC)</div><div class="ttdoc">Start internal TCP server and listen on specified port. </div></div> <div class="ttc" id="group__api__socket__misc_html_ga037cb2813683697342fff01239c7f6f8"><div class="ttname"><a href="group__api__socket__misc.html#ga037cb2813683697342fff01239c7f6f8">wiconnect::SocketInterface::connect</a></div><div class="ttdeci">WiconnectResult connect(WiconnectSocket &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> -<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#l00317">WiconnectTypes.h:317</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#l00326">WiconnectTypes.h:326</a></div></div> +<div class="ttc" id="group__api__core__macro_html_gaa1dbeca66111f3a22d0ee6b122d69270"><div class="ttname"><a href="group__api__core__macro.html#gaa1dbeca66111f3a22d0ee6b122d69270">PIN_NC</a></div><div class="ttdeci">#define PIN_NC</div><div class="ttdoc">Default value for a pin, Not connected. </div><div class="ttdef"><b>Definition:</b> <a href="sdk_8h_source.html#l00117">sdk.h:117</a></div></div> <div class="ttc" id="group__api__socket__http_html_gadf59ca0783b89ee32f205e33f1bd5517"><div class="ttname"><a href="group__api__socket__http.html#gadf59ca0783b89ee32f205e33f1bd5517">wiconnect::SocketInterface::httpGetStatus</a></div><div class="ttdeci">WiconnectResult httpGetStatus(WiconnectSocket &socket, uint32_t *statusCodePtr)</div><div class="ttdoc">Get the HTTP status code from HTTP request. </div></div> </div><!-- fragment --></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