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:
13:2b51f5267c92
Parent:
11:ea484e1b7fc4
Child:
16:7f1d6d359787
--- a/doc/html/classes.html	Tue Aug 12 02:44:34 2014 -0700
+++ b/doc/html/classes.html	Wed Aug 13 03:14:30 2014 -0700
@@ -3,8 +3,9 @@
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
-<meta name="generator" content="Doxygen 1.8.7"/>
-<title>WiConnect Library: Class Index</title>
+<title>ACKme WiConnect Host Library</title>
+<link rel="icon" href="favicon.ico" type="image/x-icon">
+<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>
@@ -24,29 +25,30 @@
 </head>
 <body>
 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
-<div id="titlearea">
-<table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
-  <td style="padding-left: 0.5em;">
-   <div id="projectname">WiConnect Library
-   </div>
-  </td>
- </tr>
- </tbody>
-</table>
-</div>
-<!-- end header part -->
-<!-- Generated by Doxygen 1.8.7 -->
+<div id="titlearea" style="font-family:verdana;">
+    <table border='0' cellpadding='0' cellspacing='0' width="98%">
+      <tr style="height:20px"><td>&nbsp;</td></tr>
+      <tr style="border-collapse: collapse; padding: 0;">
+        <td style="width:20px"></td>
+        <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
+        <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
+        WiConnect Host Library- API Reference Guide</td>
+        <td style="width:20px"></td>
+      </tr>
+      <tr><td>&nbsp;</td></tr>
+    </table>
+</div><!-- Generated by Doxygen 1.8.7 -->
 <script type="text/javascript">
 var searchBox = new SearchBox("searchBox", "search",false,'Search');
 </script>
   <div id="navrow1" class="tabs">
     <ul class="tablist">
-      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
-      <li><a href="modules.html"><span>Modules</span></a></li>
-      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+      <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
+      <li><a href="modules.html"><span>Library&#160;API</span></a></li>
+      <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+      <li><a href="http://wiconnect.ack.me/1.2/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
+      <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
       <li>
         <div id="MSearchBox" class="MSearchBoxInactive">
         <span class="left">
@@ -107,45 +109,37 @@
 <div class="title">Class Index</div>  </div>
 </div><!--header-->
 <div class="contents">
-<div class="qindex"><a class="qindex" href="#letter_B">B</a>&#160;|&#160;<a class="qindex" href="#letter_C">C</a>&#160;|&#160;<a class="qindex" href="#letter_F">F</a>&#160;|&#160;<a class="qindex" href="#letter_H">H</a>&#160;|&#160;<a class="qindex" href="#letter_L">L</a>&#160;|&#160;<a class="qindex" href="#letter_M">M</a>&#160;|&#160;<a class="qindex" href="#letter_N">N</a>&#160;|&#160;<a class="qindex" href="#letter_Q">Q</a>&#160;|&#160;<a class="qindex" href="#letter_R">R</a>&#160;|&#160;<a class="qindex" href="#letter_S">S</a>&#160;|&#160;<a class="qindex" href="#letter_T">T</a>&#160;|&#160;<a class="qindex" href="#letter_W">W</a>&#160;|&#160;<a class="qindex" href="#letter__">_</a></div>
+<div class="qindex"><a class="qindex" href="#letter_C">C</a>&#160;|&#160;<a class="qindex" href="#letter_F">F</a>&#160;|&#160;<a class="qindex" href="#letter_H">H</a>&#160;|&#160;<a class="qindex" href="#letter_L">L</a>&#160;|&#160;<a class="qindex" href="#letter_M">M</a>&#160;|&#160;<a class="qindex" href="#letter_N">N</a>&#160;|&#160;<a class="qindex" href="#letter_Q">Q</a>&#160;|&#160;<a class="qindex" href="#letter_R">R</a>&#160;|&#160;<a class="qindex" href="#letter_S">S</a>&#160;|&#160;<a class="qindex" href="#letter_W">W</a></div>
 <table style="margin: 10px; white-space: nowrap;" align="center" width="95%" border="0" cellspacing="0" cellpadding="0">
-<tr><td rowspan="2" valign="bottom"><a name="letter_B"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;B&#160;&#160;</div></td></tr></table>
-</td><td valign="top"><a class="el" href="classwiconnect_1_1_file_list.html">FileList</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td rowspan="2" valign="bottom"><a name="letter_N"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;N&#160;&#160;</div></td></tr></table>
-</td><td valign="top"><a class="el" href="classwiconnect_1_1_scan_result_list.html">ScanResultList</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classwiconnect_1_1_w_i_c_o_n_n_e_c_t___e_x_t_e_r_n_a_l___i_n_t_e_r_r_u_p_t___g_p_i_o___b_a_s_e___c_l_a_s_s.html">WICONNECT_EXTERNAL_INTERRUPT_GPIO_BASE_CLASS</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td></tr>
-<tr><td valign="top"><a class="el" href="classwiconnect_1_1_function_pointer.html">FunctionPointer</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classwiconnect_1_1_socket.html">Socket</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classwiconnect_1_1_w_i_c_o_n_n_e_c_t___g_p_i_o___b_a_s_e___c_l_a_s_s.html">WICONNECT_GPIO_BASE_CLASS</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td></tr>
-<tr><td valign="top"><a class="el" href="structwiconnect_1_1_buffer.html">Buffer</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td rowspan="2" valign="bottom"><a name="letter_H"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;H&#160;&#160;</div></td></tr></table>
-</td><td valign="top"><a class="el" href="classwiconnect_1_1_network_interface.html">NetworkInterface</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classwiconnect_1_1_socket_interface.html">SocketInterface</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classwiconnect_1_1_w_i_c_o_n_n_e_c_t___p_e_r_i_o_d_i_c___t_i_m_e_r___b_a_s_e___c_l_a_s_s.html">WICONNECT_PERIODIC_TIMER_BASE_CLASS</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td></tr>
 <tr><td rowspan="2" valign="bottom"><a name="letter_C"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;C&#160;&#160;</div></td></tr></table>
-</td><td rowspan="2" valign="bottom"><a name="letter_Q"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;Q&#160;&#160;</div></td></tr></table>
-</td><td valign="top"><a class="el" href="classwiconnect_1_1_socket_irq_handler_map.html">SocketIrqHandlerMap</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classwiconnect_1_1_w_i_c_o_n_n_e_c_t___s_e_r_i_a_l___b_a_s_e___c_l_a_s_s.html">WICONNECT_SERIAL_BASE_CLASS</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td></tr>
-<tr><td valign="top"><a class="el" href="structwiconnect_1_1_http_socket_args.html">HttpSocketArgs</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="structwiconnect_1_1_ssid.html">Ssid</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td rowspan="2" valign="bottom"><a name="letter__"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;_&#160;&#160;</div></td></tr></table>
+</td><td valign="top"><a class="el" href="classwiconnect_1_1_function_pointer.html">FunctionPointer</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td rowspan="2" valign="bottom"><a name="letter_N"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;N&#160;&#160;</div></td></tr></table>
+</td><td rowspan="2" valign="bottom"><a name="letter_S"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;S&#160;&#160;</div></td></tr></table>
+</td><td rowspan="2" valign="bottom"><a name="letter_W"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;W&#160;&#160;</div></td></tr></table>
+</td></tr>
+<tr><td rowspan="2" valign="bottom"><a name="letter_H"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;H&#160;&#160;</div></td></tr></table>
 </td></tr>
-<tr><td valign="top"><a class="el" href="classwiconnect_1_1_callback.html">Callback</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td rowspan="2" valign="bottom"><a name="letter_L"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;L&#160;&#160;</div></td></tr></table>
-</td><td valign="top"><a class="el" href="classwiconnect_1_1_queued_command.html">QueuedCommand</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td rowspan="2" valign="bottom"><a name="letter_T"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;T&#160;&#160;</div></td></tr></table>
-</td></tr>
-<tr><td valign="top"><a class="el" href="classwiconnect_1_1_command_queue.html">CommandQueue</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td rowspan="2" valign="bottom"><a name="letter_R"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;R&#160;&#160;</div></td></tr></table>
-</td><td valign="top"><a class="el" href="structwiconnect_1_1___serial_config.html">_SerialConfig</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td></tr>
+<tr><td valign="top"><a class="el" href="classwiconnect_1_1_callback.html">Callback</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classwiconnect_1_1_network_interface.html">NetworkInterface</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classwiconnect_1_1_scan_result.html">ScanResult</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td></tr>
 <tr><td rowspan="2" valign="bottom"><a name="letter_F"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;F&#160;&#160;</div></td></tr></table>
-</td><td valign="top"><a class="el" href="classwiconnect_1_1_log_func.html">LogFunc</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classwiconnect_1_1_timeout_timer.html">TimeoutTimer</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td></td></tr>
-<tr><td rowspan="2" valign="bottom"><a name="letter_M"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;M&#160;&#160;</div></td></tr></table>
-</td><td valign="top"><a class="el" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td rowspan="2" valign="bottom"><a name="letter_W"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;W&#160;&#160;</div></td></tr></table>
-</td><td></td></tr>
-<tr><td valign="top"><a class="el" href="classwiconnect_1_1_file.html">File</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td rowspan="2" valign="bottom"><a name="letter_S"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;S&#160;&#160;</div></td></tr></table>
-</td><td></td></tr>
-<tr><td valign="top"><a class="el" href="classwiconnect_1_1_file_interface.html">FileInterface</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="structwiconnect_1_1_mac_address.html">MacAddress</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classwiconnect_1_1_wiconnect.html">Wiconnect</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td></td></tr>
-<tr><td></td><td></td><td valign="top"><a class="el" href="classwiconnect_1_1_scan_result.html">ScanResult</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td></td><td></td></tr>
+</td><td valign="top"><a class="el" href="structwiconnect_1_1_http_socket_args.html">HttpSocketArgs</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td rowspan="2" valign="bottom"><a name="letter_Q"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;Q&#160;&#160;</div></td></tr></table>
+</td><td valign="top"><a class="el" href="classwiconnect_1_1_scan_result_list.html">ScanResultList</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td></td></tr>
+<tr><td rowspan="2" valign="bottom"><a name="letter_L"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;L&#160;&#160;</div></td></tr></table>
+</td><td valign="top"><a class="el" href="classwiconnect_1_1_serial_config.html">SerialConfig</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td></td></tr>
+<tr><td valign="top"><a class="el" href="classwiconnect_1_1_file.html">File</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classwiconnect_1_1_queued_command.html">QueuedCommand</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classwiconnect_1_1_socket.html">Socket</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td></td></tr>
+<tr><td valign="top"><a class="el" href="classwiconnect_1_1_file_interface.html">FileInterface</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td valign="top"><a class="el" href="classwiconnect_1_1_log_func.html">LogFunc</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td rowspan="2" valign="bottom"><a name="letter_R"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;R&#160;&#160;</div></td></tr></table>
+</td><td valign="top"><a class="el" href="classwiconnect_1_1_socket_interface.html">SocketInterface</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td></td></tr>
+<tr><td valign="top"><a class="el" href="classwiconnect_1_1_file_list.html">FileList</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td rowspan="2" valign="bottom"><a name="letter_M"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;M&#160;&#160;</div></td></tr></table>
+</td><td valign="top"><a class="el" href="structwiconnect_1_1_ssid.html">Ssid</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td></td></tr>
+<tr><td></td><td valign="top"><a class="el" href="classwiconnect_1_1_reader_func.html">ReaderFunc</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a class="el" href="structwiconnect_1_1_mac_address.html">MacAddress</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td><td></td><td></td><td></td></tr>
 <tr><td></td><td></td><td></td><td></td><td></td></tr>
 </table>
-<div class="qindex"><a class="qindex" href="#letter_B">B</a>&#160;|&#160;<a class="qindex" href="#letter_C">C</a>&#160;|&#160;<a class="qindex" href="#letter_F">F</a>&#160;|&#160;<a class="qindex" href="#letter_H">H</a>&#160;|&#160;<a class="qindex" href="#letter_L">L</a>&#160;|&#160;<a class="qindex" href="#letter_M">M</a>&#160;|&#160;<a class="qindex" href="#letter_N">N</a>&#160;|&#160;<a class="qindex" href="#letter_Q">Q</a>&#160;|&#160;<a class="qindex" href="#letter_R">R</a>&#160;|&#160;<a class="qindex" href="#letter_S">S</a>&#160;|&#160;<a class="qindex" href="#letter_T">T</a>&#160;|&#160;<a class="qindex" href="#letter_W">W</a>&#160;|&#160;<a class="qindex" href="#letter__">_</a></div>
+<div class="qindex"><a class="qindex" href="#letter_C">C</a>&#160;|&#160;<a class="qindex" href="#letter_F">F</a>&#160;|&#160;<a class="qindex" href="#letter_H">H</a>&#160;|&#160;<a class="qindex" href="#letter_L">L</a>&#160;|&#160;<a class="qindex" href="#letter_M">M</a>&#160;|&#160;<a class="qindex" href="#letter_N">N</a>&#160;|&#160;<a class="qindex" href="#letter_Q">Q</a>&#160;|&#160;<a class="qindex" href="#letter_R">R</a>&#160;|&#160;<a class="qindex" href="#letter_S">S</a>&#160;|&#160;<a class="qindex" href="#letter_W">W</a></div>
 </div><!-- contents -->
 </div><!-- doc-content -->
-<!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
-    <li class="footer">Generated on Tue Aug 12 2014 02:15:27 for WiConnect Library by
-    <a href="http://www.doxygen.org/index.html">
-    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
+    <li class="footer">&copy; ACKme Networks 2014</li>
   </ul>
 </div>
 </body>
-</html>
+</html>
\ No newline at end of file