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/namespacewiconnect.html
- Revision:
- 29:b6af04b77a56
- Parent:
- 26:8067e3d463d3
--- a/doc/html/namespacewiconnect.html Mon Oct 27 13:32:40 2014 -0700 +++ b/doc/html/namespacewiconnect.html Mon Oct 27 13:42:26 2014 -0700 @@ -123,6 +123,21 @@ <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_function_pointer.html">FunctionPointer</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Generic function pointer. <a href="classwiconnect_1_1_function_pointer.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structwiconnect_1_1_ghm_element.html">GhmElement</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">goHACK.me stream or control value <a href="structwiconnect_1_1_ghm_element.html#details">More...</a><br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structwiconnect_1_1_ghm_element_array.html">GhmElementArray</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Array of goHACK.me stream or control values. <a href="structwiconnect_1_1_ghm_element_array.html#details">More...</a><br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_ghm_interface.html">GhmInterface</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The provides an interface for <a href="http://goHACK.me">http://goHACK.me</a>. <a href="classwiconnect_1_1_ghm_interface.html#details">More...</a><br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_ghm_message.html">GhmMessage</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Contains single entry from goHACK.me message listing. <a href="classwiconnect_1_1_ghm_message.html#details">More...</a><br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_ghm_message_list.html">GhmMessageList</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">List of goHACK.me messages. <a href="classwiconnect_1_1_ghm_message_list.html#details">More...</a><br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structwiconnect_1_1_http_socket_args.html">HttpSocketArgs</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Struct for hold HTTP socket configuration. <a href="structwiconnect_1_1_http_socket_args.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> @@ -165,12 +180,19 @@ <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Connection object to remote server. <a href="classwiconnect_1_1_wiconnect_socket.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_wiconnect_udp_server.html">WiconnectUdpServer</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">UDP Server Listening socket. <a href="classwiconnect_1_1_wiconnect_udp_server.html#details">More...</a><br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr class="memitem:aadd4d5e6774e21f382c20b594a644470"><td class="memItemLeft" align="right" valign="top">typedef int8_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacewiconnect.html#aadd4d5e6774e21f382c20b594a644470">PinToGpioMapper</a> )(<a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">Pin</a> pin)</td></tr> <tr class="memdesc:aadd4d5e6774e21f382c20b594a644470"><td class="mdescLeft"> </td><td class="mdescRight">Function pointer for mapping from a host pin to a WiConnect Module GPIO. <a href="#aadd4d5e6774e21f382c20b594a644470">More...</a><br /></td></tr> <tr class="separator:aadd4d5e6774e21f382c20b594a644470"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0c27570b2913afc6339821df7c934810"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0c27570b2913afc6339821df7c934810"></a> +typedef unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacewiconnect.html#a0c27570b2913afc6339821df7c934810">TimerTimeout</a></td></tr> +<tr class="memdesc:a0c27570b2913afc6339821df7c934810"><td class="mdescLeft"> </td><td class="mdescRight">Timeout type. <br /></td></tr> +<tr class="separator:a0c27570b2913afc6339821df7c934810"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga04b095d2e2f32a3fd23e346a4be969d8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga04b095d2e2f32a3fd23e346a4be969d8"></a> typedef char </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__types.html#ga04b095d2e2f32a3fd23e346a4be969d8">MacAddressStrBuffer</a> [18]</td></tr> <tr class="memdesc:ga04b095d2e2f32a3fd23e346a4be969d8"><td class="mdescLeft"> </td><td class="mdescRight">Buffer to hold a MAC address string. <br /></td></tr> @@ -300,7 +322,11 @@ <br />   <a class="el" href="group__api__socket__types.html#gga69dc55558df4c81599c5fb3dff98756dab1b41b1c4daf8d171414b68e9033cfbc">SOCKET_TYPE_UDP</a>, <br /> -  <a class="el" href="group__api__socket__types.html#gga69dc55558df4c81599c5fb3dff98756da3d433f1b569dc48077861cde0e464751">SOCKET_TYPE_HTTP</a> +  <a class="el" href="group__api__socket__types.html#gga69dc55558df4c81599c5fb3dff98756da3d433f1b569dc48077861cde0e464751">SOCKET_TYPE_HTTP</a>, +<br /> +  <a class="el" href="group__api__socket__types.html#gga69dc55558df4c81599c5fb3dff98756da77625728d545a400e0eae1483225ff91">SOCKET_TYPE_UDPS</a>, +<br /> +  <a class="el" href="group__api__socket__types.html#gga69dc55558df4c81599c5fb3dff98756da94c82597ad724e81c0bace9ed64ebc5f">SOCKET_TYPE_GHM</a> <br /> }</td></tr> <tr class="memdesc:ga69dc55558df4c81599c5fb3dff98756d"><td class="mdescLeft"> </td><td class="mdescRight">Socket type. <a href="group__api__socket__types.html#ga69dc55558df4c81599c5fb3dff98756d">More...</a><br /></td></tr> @@ -365,6 +391,29 @@ }</td></tr> <tr class="memdesc:ga9919a4237eea2b0d1f27c16d64e62c63"><td class="mdescLeft"> </td><td class="mdescRight">File type type. <a href="group__api__file__types.html#ga9919a4237eea2b0d1f27c16d64e62c63">More...</a><br /></td></tr> <tr class="separator:ga9919a4237eea2b0d1f27c16d64e62c63"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga4174104f02851ee92e51846877706e67"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4174104f02851ee92e51846877706e67"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__types.html#ga4174104f02851ee92e51846877706e67">GhmElementValueType</a> </td></tr> +<tr class="memdesc:ga4174104f02851ee92e51846877706e67"><td class="mdescLeft"> </td><td class="mdescRight">goHACK.me stream or control value type <br /></td></tr> +<tr class="separator:ga4174104f02851ee92e51846877706e67"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga44ea17651dcf42ac9816f549beb577ac"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__types.html#ga44ea17651dcf42ac9816f549beb577ac">GhmSyncType</a> { <br /> +  <a class="el" href="group__api__ghm__types.html#gga44ea17651dcf42ac9816f549beb577aca8aa4d4efd897cd69e0f08feaeaa122e7">GHM_SYNC_ALL</a>, +<br /> +  <a class="el" href="group__api__ghm__types.html#gga44ea17651dcf42ac9816f549beb577acafcf2af6407845b24a3abac79587243e0">GHM_SYNC_PUSH_ONLY</a>, +<br /> +  <a class="el" href="group__api__ghm__types.html#gga44ea17651dcf42ac9816f549beb577acaad5fbcfa42d14a2662bc5a517c108bdd">GHM_SYNC_PULL_ONLY</a> +<br /> + }</td></tr> +<tr class="memdesc:ga44ea17651dcf42ac9816f549beb577ac"><td class="mdescLeft"> </td><td class="mdescRight">goHACK.me sychronization type <a href="group__api__ghm__types.html#ga44ea17651dcf42ac9816f549beb577ac">More...</a><br /></td></tr> +<tr class="separator:ga44ea17651dcf42ac9816f549beb577ac"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaf75750bfef61c73f9e4677e9de663df1"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__types.html#gaf75750bfef61c73f9e4677e9de663df1">GhmMessageGetType</a> { <br /> +  <a class="el" href="group__api__ghm__types.html#ggaf75750bfef61c73f9e4677e9de663df1a7b67ad45967438f44f6942968fb72127">GHM_MSG_GET_DATA_ONLY</a>, +<br /> +  <a class="el" href="group__api__ghm__types.html#ggaf75750bfef61c73f9e4677e9de663df1a19876ca1d097b96c48a1e8b54ee562d1">GHM_MSG_GET_BODY</a>, +<br /> +  <a class="el" href="group__api__ghm__types.html#ggaf75750bfef61c73f9e4677e9de663df1adcf75ccabf6676b9b8f3050080f4bab7">GHM_MSG_GET_ALL</a> +<br /> + }</td></tr> +<tr class="memdesc:gaf75750bfef61c73f9e4677e9de663df1"><td class="mdescLeft"> </td><td class="mdescRight">goHACK.me message GET type <a href="group__api__ghm__types.html#gaf75750bfef61c73f9e4677e9de663df1">More...</a><br /></td></tr> +<tr class="separator:gaf75750bfef61c73f9e4677e9de663df1"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>The entire <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> Library is contained within the 'wiconnect' namespace. </p> @@ -397,7 +446,7 @@ </dl> <dl class="section return"><dt>Returns</dt><dd>The corresponding WiConnect Module GPIO (which the given pin is physically connected). Return -1 if no mapping is available. </dd></dl> -<p>Definition at line <a class="el" href="_wiconnect_types_8h_source.html#l00199">199</a> of file <a class="el" href="_wiconnect_types_8h_source.html">WiconnectTypes.h</a>.</p> +<p>Definition at line <a class="el" href="_wiconnect_types_8h_source.html#l00206">206</a> of file <a class="el" href="_wiconnect_types_8h_source.html">WiconnectTypes.h</a>.</p> </div> </div>