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

Revision:
29:b6af04b77a56
Parent:
26:8067e3d463d3
--- a/doc/html/annotated.html	Mon Oct 27 13:32:40 2014 -0700
+++ b/doc/html/annotated.html	Mon Oct 27 13:42:26 2014 -0700
@@ -116,20 +116,26 @@
 <tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_file_interface.html" target="_self">FileInterface</a></td><td class="desc">The provides an interface for creating TCP/UDP/TLS/HTTP client sockets. A client socket connects to a remote server </td></tr>
 <tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_file_list.html" target="_self">FileList</a></td><td class="desc">WiConnect WiFi module file listing </td></tr>
 <tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_function_pointer.html" target="_self">FunctionPointer</a></td><td class="desc">Generic function pointer </td></tr>
-<tr id="row_0_4_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structwiconnect_1_1_http_socket_args.html" target="_self">HttpSocketArgs</a></td><td class="desc">Struct for hold HTTP socket configuration </td></tr>
-<tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_log_func.html" target="_self">LogFunc</a></td><td class="desc">Logging callback function </td></tr>
-<tr id="row_0_6_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structwiconnect_1_1_mac_address.html" target="_self">MacAddress</a></td><td class="desc">Network MAC Address type </td></tr>
-<tr id="row_0_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_network_interface.html" target="_self">NetworkInterface</a></td><td class="desc">The provides an interface for joining and/or creating a network. It provides other utilities such as scanning for networks, pinging a network, resolving a domain name to IP address </td></tr>
-<tr id="row_0_8_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_queued_command.html" target="_self">QueuedCommand</a></td><td class="desc">Class which contains command for asynchronous processing </td></tr>
-<tr id="row_0_9_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_reader_func.html" target="_self">ReaderFunc</a></td><td class="desc">Generic data reading callback function </td></tr>
-<tr id="row_0_10_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_scan_result.html" target="_self">ScanResult</a></td><td class="desc">Contains single entry from WiFi scan results </td></tr>
-<tr id="row_0_11_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_scan_result_list.html" target="_self">ScanResultList</a></td><td class="desc">List of WiFi network scan results </td></tr>
-<tr id="row_0_12_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_serial_config.html" target="_self">SerialConfig</a></td><td class="desc">Host&lt;-&gt;<a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> Module serial configuration </td></tr>
-<tr id="row_0_13_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_socket_interface.html" target="_self">SocketInterface</a></td><td class="desc">The provides an interface for creating TCP/UDP/TLS/HTTP client sockets. A client socket connects to a remote server </td></tr>
-<tr id="row_0_14_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structwiconnect_1_1_ssid.html" target="_self">Ssid</a></td><td class="desc">Network SSID type </td></tr>
-<tr id="row_0_15_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_wiconnect.html" target="_self">Wiconnect</a></td><td class="desc">The root WiConnect library class. This class inheriets all WiConnect functionality </td></tr>
-<tr id="row_0_16_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_wiconnect_file.html" target="_self">WiconnectFile</a></td><td class="desc">WiConnect WiFi module file object </td></tr>
-<tr id="row_0_17_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_wiconnect_socket.html" target="_self">WiconnectSocket</a></td><td class="desc">Connection object to remote server </td></tr>
+<tr id="row_0_4_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structwiconnect_1_1_ghm_element.html" target="_self">GhmElement</a></td><td class="desc">GoHACK.me stream or control value </td></tr>
+<tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structwiconnect_1_1_ghm_element_array.html" target="_self">GhmElementArray</a></td><td class="desc">Array of goHACK.me stream or control values </td></tr>
+<tr id="row_0_6_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_ghm_interface.html" target="_self">GhmInterface</a></td><td class="desc">The provides an interface for <a href="http://goHACK.me">http://goHACK.me</a> </td></tr>
+<tr id="row_0_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_ghm_message.html" target="_self">GhmMessage</a></td><td class="desc">Contains single entry from goHACK.me message listing </td></tr>
+<tr id="row_0_8_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_ghm_message_list.html" target="_self">GhmMessageList</a></td><td class="desc">List of goHACK.me messages </td></tr>
+<tr id="row_0_9_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structwiconnect_1_1_http_socket_args.html" target="_self">HttpSocketArgs</a></td><td class="desc">Struct for hold HTTP socket configuration </td></tr>
+<tr id="row_0_10_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_log_func.html" target="_self">LogFunc</a></td><td class="desc">Logging callback function </td></tr>
+<tr id="row_0_11_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structwiconnect_1_1_mac_address.html" target="_self">MacAddress</a></td><td class="desc">Network MAC Address type </td></tr>
+<tr id="row_0_12_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_network_interface.html" target="_self">NetworkInterface</a></td><td class="desc">The provides an interface for joining and/or creating a network. It provides other utilities such as scanning for networks, pinging a network, resolving a domain name to IP address </td></tr>
+<tr id="row_0_13_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_queued_command.html" target="_self">QueuedCommand</a></td><td class="desc">Class which contains command for asynchronous processing </td></tr>
+<tr id="row_0_14_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_reader_func.html" target="_self">ReaderFunc</a></td><td class="desc">Generic data reading callback function </td></tr>
+<tr id="row_0_15_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_scan_result.html" target="_self">ScanResult</a></td><td class="desc">Contains single entry from WiFi scan results </td></tr>
+<tr id="row_0_16_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_scan_result_list.html" target="_self">ScanResultList</a></td><td class="desc">List of WiFi network scan results </td></tr>
+<tr id="row_0_17_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_serial_config.html" target="_self">SerialConfig</a></td><td class="desc">Host&lt;-&gt;<a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> Module serial configuration </td></tr>
+<tr id="row_0_18_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_socket_interface.html" target="_self">SocketInterface</a></td><td class="desc">The provides an interface for creating TCP/UDP/TLS/HTTP client sockets. A client socket connects to a remote server </td></tr>
+<tr id="row_0_19_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structwiconnect_1_1_ssid.html" target="_self">Ssid</a></td><td class="desc">Network SSID type </td></tr>
+<tr id="row_0_20_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_wiconnect.html" target="_self">Wiconnect</a></td><td class="desc">The root WiConnect library class. This class inheriets all WiConnect functionality </td></tr>
+<tr id="row_0_21_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_wiconnect_file.html" target="_self">WiconnectFile</a></td><td class="desc">WiConnect WiFi module file object </td></tr>
+<tr id="row_0_22_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_wiconnect_socket.html" target="_self">WiconnectSocket</a></td><td class="desc">Connection object to remote server </td></tr>
+<tr id="row_0_23_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classwiconnect_1_1_wiconnect_udp_server.html" target="_self">WiconnectUdpServer</a></td><td class="desc">UDP Server Listening socket </td></tr>
 <tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_string_util.html" target="_self">StringUtil</a></td><td class="desc"></td></tr>
 </table>
 </div><!-- directory -->