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/mbed/html/group__api__socket__http.html
- Revision:
- 39:a963f69cb2de
- Parent:
- 34:2616445d0823
diff -r bc2b10351ee3 -r a963f69cb2de doc/mbed/html/group__api__socket__http.html --- a/doc/mbed/html/group__api__socket__http.html Thu Nov 27 10:27:18 2014 +0000 +++ b/doc/mbed/html/group__api__socket__http.html Mon Feb 23 20:30:18 2015 -0800 @@ -128,10 +128,49 @@ <tr class="memitem:gadf59ca0783b89ee32f205e33f1bd5517"><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#gadf59ca0783b89ee32f205e33f1bd5517">wiconnect::SocketInterface::httpGetStatus</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &socket, uint32_t *statusCodePtr)</td></tr> <tr class="memdesc:gadf59ca0783b89ee32f205e33f1bd5517"><td class="mdescLeft"> </td><td class="mdescRight">Get the HTTP status code from HTTP request. <a href="#gadf59ca0783b89ee32f205e33f1bd5517">More...</a><br /></td></tr> <tr class="separator:gadf59ca0783b89ee32f205e33f1bd5517"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga856d6866c6fc59ebedccade4822acbc8"><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#ga856d6866c6fc59ebedccade4822acbc8">wiconnect::SocketInterface::httpAcceptWebSocket</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:ga856d6866c6fc59ebedccade4822acbc8"><td class="mdescLeft"> </td><td class="mdescRight">Wait for next HTTP Server WebSocket to connect. <a href="#ga856d6866c6fc59ebedccade4822acbc8">More...</a><br /></td></tr> +<tr class="separator:ga856d6866c6fc59ebedccade4822acbc8"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>HTTP methods. </p> <h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="ga856d6866c6fc59ebedccade4822acbc8"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::SocketInterface::httpAcceptWebSocket </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> & </td> + <td class="paramname"><em>socket</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>timeoutMs</em> = <code><a class="el" href="group__api__core__macro.html#ga580e5f45fee866c845e0d3fd1eb1744a">WICONNECT_WAIT_FOREVER</a></code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Wait for next HTTP Server WebSocket to connect. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">socket</td><td>Socket to connected websocket </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">timeoutMs</td><td>Optional, specifiy maximum amount of time in ms to wait for a client </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl> + +</div> +</div> <a class="anchor" id="gabed18edc44f464bac64ce8a6dc3617ec"></a> <div class="memitem"> <div class="memproto">