ACKme / WiConnect

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

doc/html/classes.html@16:7f1d6d359787, 2014-08-13 (annotated)

Committer:
dan_ackme
Date:
Wed Aug 13 04:41:04 2014 -0700
Revision:
16:7f1d6d359787
Parent:
13:2b51f5267c92
Child:
17:7268f365676b
updated documentation and copyright

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 10:735194df0097 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
dan_ackme 10:735194df0097 2 <html xmlns="http://www.w3.org/1999/xhtml">
dan_ackme 10:735194df0097 3 <head>
dan_ackme 10:735194df0097 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
dan_ackme 10:735194df0097 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
dan_ackme 13:2b51f5267c92 6 <title>ACKme WiConnect Host Library</title>
dan_ackme 13:2b51f5267c92 7 <link rel="icon" href="favicon.ico" type="image/x-icon">
dan_ackme 13:2b51f5267c92 8 <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
dan_ackme 10:735194df0097 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 10:735194df0097 10 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 10:735194df0097 11 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 10:735194df0097 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 10:735194df0097 13 <script type="text/javascript" src="resize.js"></script>
dan_ackme 10:735194df0097 14 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 10:735194df0097 15 <script type="text/javascript">
dan_ackme 10:735194df0097 16 $(document).ready(initResizable);
dan_ackme 10:735194df0097 17 $(window).load(resizeHeight);
dan_ackme 10:735194df0097 18 </script>
dan_ackme 11:ea484e1b7fc4 19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 11:ea484e1b7fc4 20 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 11:ea484e1b7fc4 21 <script type="text/javascript">
dan_ackme 11:ea484e1b7fc4 22 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 11:ea484e1b7fc4 23 </script>
dan_ackme 10:735194df0097 24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 10:735194df0097 25 </head>
dan_ackme 10:735194df0097 26 <body>
dan_ackme 10:735194df0097 27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 13:2b51f5267c92 28 <div id="titlearea" style="font-family:verdana;">
dan_ackme 13:2b51f5267c92 29 <table border='0' cellpadding='0' cellspacing='0' width="98%">
dan_ackme 13:2b51f5267c92 30 <tr style="height:20px"><td>&nbsp;</td></tr>
dan_ackme 13:2b51f5267c92 31 <tr style="border-collapse: collapse; padding: 0;">
dan_ackme 13:2b51f5267c92 32 <td style="width:20px"></td>
dan_ackme 13:2b51f5267c92 33 <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
dan_ackme 13:2b51f5267c92 34 <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
dan_ackme 13:2b51f5267c92 35 WiConnect Host Library- API Reference Guide</td>
dan_ackme 13:2b51f5267c92 36 <td style="width:20px"></td>
dan_ackme 13:2b51f5267c92 37 </tr>
dan_ackme 13:2b51f5267c92 38 <tr><td>&nbsp;</td></tr>
dan_ackme 13:2b51f5267c92 39 </table>
dan_ackme 13:2b51f5267c92 40 </div><!-- Generated by Doxygen 1.8.7 -->
dan_ackme 11:ea484e1b7fc4 41 <script type="text/javascript">
dan_ackme 11:ea484e1b7fc4 42 var searchBox = new SearchBox("searchBox", "search",false,'Search');
dan_ackme 11:ea484e1b7fc4 43 </script>
dan_ackme 10:735194df0097 44 <div id="navrow1" class="tabs">
dan_ackme 10:735194df0097 45 <ul class="tablist">
dan_ackme 13:2b51f5267c92 46 <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
dan_ackme 13:2b51f5267c92 47 <li><a href="modules.html"><span>Library&#160;API</span></a></li>
dan_ackme 13:2b51f5267c92 48 <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
dan_ackme 10:735194df0097 49 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 13:2b51f5267c92 50 <li><a href="http://wiconnect.ack.me/1.2/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
dan_ackme 13:2b51f5267c92 51 <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
dan_ackme 11:ea484e1b7fc4 52 <li>
dan_ackme 11:ea484e1b7fc4 53 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 11:ea484e1b7fc4 54 <span class="left">
dan_ackme 11:ea484e1b7fc4 55 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 11:ea484e1b7fc4 56 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 11:ea484e1b7fc4 57 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 11:ea484e1b7fc4 58 alt=""/>
dan_ackme 11:ea484e1b7fc4 59 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 11:ea484e1b7fc4 60 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 11:ea484e1b7fc4 61 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 11:ea484e1b7fc4 62 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 11:ea484e1b7fc4 63 </span><span class="right">
dan_ackme 11:ea484e1b7fc4 64 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 11:ea484e1b7fc4 65 </span>
dan_ackme 11:ea484e1b7fc4 66 </div>
dan_ackme 11:ea484e1b7fc4 67 </li>
dan_ackme 10:735194df0097 68 </ul>
dan_ackme 10:735194df0097 69 </div>
dan_ackme 10:735194df0097 70 <div id="navrow2" class="tabs2">
dan_ackme 10:735194df0097 71 <ul class="tablist">
dan_ackme 10:735194df0097 72 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
dan_ackme 10:735194df0097 73 <li class="current"><a href="classes.html"><span>Class&#160;Index</span></a></li>
dan_ackme 11:ea484e1b7fc4 74 <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
dan_ackme 10:735194df0097 75 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
dan_ackme 10:735194df0097 76 </ul>
dan_ackme 10:735194df0097 77 </div>
dan_ackme 10:735194df0097 78 </div><!-- top -->
dan_ackme 10:735194df0097 79 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 10:735194df0097 80 <div id="nav-tree">
dan_ackme 10:735194df0097 81 <div id="nav-tree-contents">
dan_ackme 10:735194df0097 82 <div id="nav-sync" class="sync"></div>
dan_ackme 10:735194df0097 83 </div>
dan_ackme 10:735194df0097 84 </div>
dan_ackme 10:735194df0097 85 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 10:735194df0097 86 class="ui-resizable-handle">
dan_ackme 10:735194df0097 87 </div>
dan_ackme 10:735194df0097 88 </div>
dan_ackme 10:735194df0097 89 <script type="text/javascript">
dan_ackme 10:735194df0097 90 $(document).ready(function(){initNavTree('classes.html','');});
dan_ackme 10:735194df0097 91 </script>
dan_ackme 10:735194df0097 92 <div id="doc-content">
dan_ackme 11:ea484e1b7fc4 93 <!-- window showing the filter options -->
dan_ackme 11:ea484e1b7fc4 94 <div id="MSearchSelectWindow"
dan_ackme 11:ea484e1b7fc4 95 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 11:ea484e1b7fc4 96 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 11:ea484e1b7fc4 97 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 11:ea484e1b7fc4 98 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>
dan_ackme 11:ea484e1b7fc4 99
dan_ackme 11:ea484e1b7fc4 100 <!-- iframe showing the search results (closed by default) -->
dan_ackme 11:ea484e1b7fc4 101 <div id="MSearchResultsWindow">
dan_ackme 11:ea484e1b7fc4 102 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 11:ea484e1b7fc4 103 name="MSearchResults" id="MSearchResults">
dan_ackme 11:ea484e1b7fc4 104 </iframe>
dan_ackme 11:ea484e1b7fc4 105 </div>
dan_ackme 11:ea484e1b7fc4 106
dan_ackme 10:735194df0097 107 <div class="header">
dan_ackme 10:735194df0097 108 <div class="headertitle">
dan_ackme 10:735194df0097 109 <div class="title">Class Index</div> </div>
dan_ackme 10:735194df0097 110 </div><!--header-->
dan_ackme 10:735194df0097 111 <div class="contents">
dan_ackme 13:2b51f5267c92 112 <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>
dan_ackme 10:735194df0097 113 <table style="margin: 10px; white-space: nowrap;" align="center" width="95%" border="0" cellspacing="0" cellpadding="0">
dan_ackme 11:ea484e1b7fc4 114 <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>
dan_ackme 13:2b51f5267c92 115 </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>
dan_ackme 13:2b51f5267c92 116 </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>
dan_ackme 16:7f1d6d359787 117 </td><td valign="top"><a class="el" href="class_string_util.html">StringUtil</a>&#160;&#160;&#160;</td></tr>
dan_ackme 16:7f1d6d359787 118 <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>
dan_ackme 13:2b51f5267c92 119 </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>
dan_ackme 13:2b51f5267c92 120 </td></tr>
dan_ackme 16:7f1d6d359787 121 <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></tr>
dan_ackme 11:ea484e1b7fc4 122 <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>
dan_ackme 13:2b51f5267c92 123 </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>
dan_ackme 16:7f1d6d359787 124 </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_wiconnect.html">Wiconnect</a> (<a class="el" href="namespacewiconnect.html">wiconnect</a>)&#160;&#160;&#160;</td></tr>
dan_ackme 13:2b51f5267c92 125 <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>
dan_ackme 13:2b51f5267c92 126 </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>
dan_ackme 13:2b51f5267c92 127 <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>
dan_ackme 13:2b51f5267c92 128 <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>
dan_ackme 13:2b51f5267c92 129 </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>
dan_ackme 13:2b51f5267c92 130 <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>
dan_ackme 13:2b51f5267c92 131 </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>
dan_ackme 13:2b51f5267c92 132 <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>
dan_ackme 13:2b51f5267c92 133 <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>
dan_ackme 11:ea484e1b7fc4 134 <tr><td></td><td></td><td></td><td></td><td></td></tr>
dan_ackme 10:735194df0097 135 </table>
dan_ackme 13:2b51f5267c92 136 <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>
dan_ackme 10:735194df0097 137 </div><!-- contents -->
dan_ackme 10:735194df0097 138 </div><!-- doc-content -->
dan_ackme 10:735194df0097 139 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 10:735194df0097 140 <ul>
dan_ackme 13:2b51f5267c92 141 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 10:735194df0097 142 </ul>
dan_ackme 10:735194df0097 143 </div>
dan_ackme 10:735194df0097 144 </body>
dan_ackme 13:2b51f5267c92 145 </html>