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:
17:7268f365676b
--- a/doc/html/classwiconnect_1_1_wiconnect-members.html	Tue Aug 12 02:44:34 2014 -0700
+++ b/doc/html/classwiconnect_1_1_wiconnect-members.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: Member List</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">
@@ -113,10 +115,10 @@
   <tr class="even"><td class="entry"><a class="el" href="group__api__core__send__command.html#gaf48c1ec0b92af2619ab846baaaa471cd">checkCurrentCommand</a>()</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="group__api__socket__misc.html#ga8a80d96efac7cc514fe7fc61d1878106">closeAllSockets</a>()</td><td class="entry"><a class="el" href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="group__api__socket__misc.html#gaf9a5b041736d79110a90716f1aaf9a6b">connect</a>(Socket &amp;socket, SocketType type, const char *host, uint16_t remortPort, uint16_t localPort, const void *args, Pin irqPin)</td><td class="entry"><a class="el" href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="group__api__file.html#ga16fb09105975644879eb09581ce486e5">createFile</a>(const ReaderFunc &amp;reader, void *user, const char *name, uint32_t size, uint32_t version=0, FileType type=FILE_TYPE_ANY, bool isEssential=false, int32_t checksum=-1)</td><td class="entry"><a class="el" href="classwiconnect_1_1_file_interface.html">wiconnect::FileInterface</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="group__api__file__methods.html#ga16fb09105975644879eb09581ce486e5">createFile</a>(const ReaderFunc &amp;reader, void *user, const char *name, uint32_t size, uint32_t version=0, FileType type=FILE_TYPE_ANY, bool isEssential=false, int32_t checksum=-1)</td><td class="entry"><a class="el" href="classwiconnect_1_1_file_interface.html">wiconnect::FileInterface</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="group__api__core__misc.html#ga9d6c981a54c6ab964b469e4f247142d6">deinit</a>()</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="group__api__file.html#gafcf335cef42b7b3d0fd9d5af70c6ef7d">deleteFile</a>(const char *name)</td><td class="entry"><a class="el" href="classwiconnect_1_1_file_interface.html">wiconnect::FileInterface</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="group__api__file.html#ga498cb32c0877b69c2c97365e5c309c46">deleteFile</a>(const File &amp;file)</td><td class="entry"><a class="el" href="classwiconnect_1_1_file_interface.html">wiconnect::FileInterface</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="group__api__file__methods.html#gafcf335cef42b7b3d0fd9d5af70c6ef7d">deleteFile</a>(const char *name)</td><td class="entry"><a class="el" href="classwiconnect_1_1_file_interface.html">wiconnect::FileInterface</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="group__api__file__methods.html#ga498cb32c0877b69c2c97365e5c309c46">deleteFile</a>(const File &amp;file)</td><td class="entry"><a class="el" href="classwiconnect_1_1_file_interface.html">wiconnect::FileInterface</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="group__conversion__util.html#ga7503f1876a6e1f5086d8b4bb2c1a653a">fileFlagsToStr</a>(FileFlags flags, char *buffer=NULL)</td><td class="entry"><a class="el" href="classwiconnect_1_1_file_interface.html">wiconnect::FileInterface</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="group__conversion__util.html#ga8d8da39cd5d2948367429ed4d8885c6b">fileTypeToStr</a>(FileType type)</td><td class="entry"><a class="el" href="classwiconnect_1_1_file_interface.html">wiconnect::FileInterface</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
   <tr><td class="entry"><a class="el" href="group__conversion__util.html#gad74fbe6faf90d987b31380978f3ea341">fileVersionIntToStr</a>(uint32_t version, bool verbose=true, char *buffer=NULL)</td><td class="entry"><a class="el" href="classwiconnect_1_1_file_interface.html">wiconnect::FileInterface</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
@@ -145,12 +147,12 @@
   <tr class="even"><td class="entry"><a class="el" href="group__api__network__setup.html#gab52d3a01427d0e8bd52460d992144f65">isWebSetupRunning</a>(bool *isRunningPtr)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="group__api__network__wlan.html#gac439d0af5a17da32d405e25dcba83d16">join</a>(const char *ssid=NULL, const char *password=NULL, const Callback &amp;completeHandler=Callback())</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="group__api__network__wlan.html#ga14dc0f4fa58a7ebb25b77fae22052328">leave</a>()</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="group__api__file.html#ga10536639c61213c037883dade021838f">listFiles</a>(FileList &amp;list, const char *name=NULL, FileType type=FILE_TYPE_ANY, uint32_t version=0)</td><td class="entry"><a class="el" href="classwiconnect_1_1_file_interface.html">wiconnect::FileInterface</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="group__api__file__methods.html#ga10536639c61213c037883dade021838f">listFiles</a>(FileList &amp;list, const char *name=NULL, FileType type=FILE_TYPE_ANY, uint32_t version=0)</td><td class="entry"><a class="el" href="classwiconnect_1_1_file_interface.html">wiconnect::FileInterface</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="group__api__network__util.html#ga1770babfc2abc6da7c085ef92709ee89">lookup</a>(const char *domain, uint32_t *ipAddressPtr)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="group__conversion__util.html#ga13ecaf390b4bf4a68b51a6b18e669134">macAddressToStr</a>(const MacAddress *macAddress, char *macStrBuffer=NULL)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="group__conversion__util.html#gae02c549079cfb0350117cd6343a3d66f">networkSecurityToStr</a>(NetworkSecurity security)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
   <tr><td class="entry"><a class="el" href="group__conversion__util.html#gacff5a4927d79e8b4c0d5a3050f5950b0">networkStatusToStr</a>(NetworkStatus status)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="group__api__file.html#ga4b14d6c68d4d0239e150def385c334a4">openFile</a>(File &amp;file, const char *name)</td><td class="entry"><a class="el" href="classwiconnect_1_1_file_interface.html">wiconnect::FileInterface</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="group__api__file__methods.html#ga4b14d6c68d4d0239e150def385c334a4">openFile</a>(File &amp;file, const char *name)</td><td class="entry"><a class="el" href="classwiconnect_1_1_file_interface.html">wiconnect::FileInterface</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="group__api__network__util.html#ga1da909dadb6f0e90218927ed350f72bc">ping</a>(const char *domain=NULL, uint32_t *timeMsPtr=NULL)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="group__api__socket__misc.html#ga94d1eb5407cb8b60ad366ecbe0e1b52a">registerSocketIrqHandler</a>(Pin irqPin, const Callback &amp;handler)</td><td class="entry"><a class="el" href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="group__api__core__misc.html#gabec1504eb7f486085dad82c4a94310e3">reset</a>()</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
@@ -192,17 +194,14 @@
   <tr><td class="entry"><a class="el" href="group__api__socket__udp.html#ga1a7ee47642c572db433e68eaee65c44c">udpConnect</a>(Socket &amp;socket, const char *host, uint16_t remortPort, uint16_t localPort=SOCKET_ANY_PORT, Pin irqPin=NC)</td><td class="entry"><a class="el" href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="group__api__socket__misc.html#ga820d2fdb12d343212638e55633bd8551">unregisterSocketIrqHandler</a>(Pin irqPin)</td><td class="entry"><a class="el" href="classwiconnect_1_1_socket_interface.html">wiconnect::SocketInterface</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="group__api__core__misc.html#gad552c8f23dd0a0e8844ee1fc4d9358e5">wakeup</a>()</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="group__types__core.html#ga285510a2cba5341db387101ac75a4389">Wiconnect</a>(const SerialConfig &amp;serialConfig, Pin reset=PIN_NC, Pin wake=PIN_NC, bool nonBlocking=WICONNECT_DEFAULT_NONBLOCKING WICONNECT_MALLOC_ARGS)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="group__types__core.html#gad39105b9aa5858c3b3bbf81b2cebcd30">Wiconnect</a>(const SerialConfig &amp;serialConfig, void *internalBuffer, int internalBufferSize, Pin reset=PIN_NC, Pin wake=PIN_NC, bool nonBlocking=WICONNECT_DEFAULT_NONBLOCKING WICONNECT_MALLOC_ARGS)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html#a285510a2cba5341db387101ac75a4389">Wiconnect</a>(const SerialConfig &amp;serialConfig, Pin reset=PIN_NC, Pin wake=PIN_NC, bool nonBlocking=WICONNECT_DEFAULT_NONBLOCKING WICONNECT_MALLOC_ARGS)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html#afe9fa2efde4e26944cdc9b6be51a1a34">Wiconnect</a>(const SerialConfig &amp;serialConfig, int internalBufferSize, void *internalBuffer=NULL, Pin reset=PIN_NC, Pin wake=PIN_NC, bool nonBlocking=WICONNECT_DEFAULT_NONBLOCKING WICONNECT_MALLOC_ARGS)</td><td class="entry"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td><td class="entry"></td></tr>
 </table></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:26 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