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/annotated.html@11:ea484e1b7fc4, 2014-08-12 (annotated)

Committer:
dan_ackme
Date:
Tue Aug 12 02:34:46 2014 -0700
Revision:
11:ea484e1b7fc4
Parent:
10:735194df0097
Child:
13:2b51f5267c92
updated documnetation

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 10:735194df0097 6 <meta name="generator" content="Doxygen 1.8.7"/>
dan_ackme 10:735194df0097 7 <title>WiConnect Library: Class List</title>
dan_ackme 10:735194df0097 8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 10:735194df0097 9 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 10:735194df0097 10 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 10:735194df0097 11 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 10:735194df0097 12 <script type="text/javascript" src="resize.js"></script>
dan_ackme 10:735194df0097 13 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 10:735194df0097 14 <script type="text/javascript">
dan_ackme 10:735194df0097 15 $(document).ready(initResizable);
dan_ackme 10:735194df0097 16 $(window).load(resizeHeight);
dan_ackme 10:735194df0097 17 </script>
dan_ackme 11:ea484e1b7fc4 18 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 11:ea484e1b7fc4 19 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 11:ea484e1b7fc4 20 <script type="text/javascript">
dan_ackme 11:ea484e1b7fc4 21 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 11:ea484e1b7fc4 22 </script>
dan_ackme 10:735194df0097 23 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 10:735194df0097 24 </head>
dan_ackme 10:735194df0097 25 <body>
dan_ackme 10:735194df0097 26 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 10:735194df0097 27 <div id="titlearea">
dan_ackme 10:735194df0097 28 <table cellspacing="0" cellpadding="0">
dan_ackme 10:735194df0097 29 <tbody>
dan_ackme 10:735194df0097 30 <tr style="height: 56px;">
dan_ackme 10:735194df0097 31 <td style="padding-left: 0.5em;">
dan_ackme 10:735194df0097 32 <div id="projectname">WiConnect Library
dan_ackme 10:735194df0097 33 </div>
dan_ackme 10:735194df0097 34 </td>
dan_ackme 10:735194df0097 35 </tr>
dan_ackme 10:735194df0097 36 </tbody>
dan_ackme 10:735194df0097 37 </table>
dan_ackme 10:735194df0097 38 </div>
dan_ackme 10:735194df0097 39 <!-- end header part -->
dan_ackme 10:735194df0097 40 <!-- 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 10:735194df0097 46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
dan_ackme 10:735194df0097 47 <li><a href="modules.html"><span>Modules</span></a></li>
dan_ackme 11:ea484e1b7fc4 48 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
dan_ackme 10:735194df0097 49 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 11:ea484e1b7fc4 50 <li>
dan_ackme 11:ea484e1b7fc4 51 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 11:ea484e1b7fc4 52 <span class="left">
dan_ackme 11:ea484e1b7fc4 53 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 11:ea484e1b7fc4 54 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 11:ea484e1b7fc4 55 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 11:ea484e1b7fc4 56 alt=""/>
dan_ackme 11:ea484e1b7fc4 57 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 11:ea484e1b7fc4 58 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 11:ea484e1b7fc4 59 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 11:ea484e1b7fc4 60 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 11:ea484e1b7fc4 61 </span><span class="right">
dan_ackme 11:ea484e1b7fc4 62 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 11:ea484e1b7fc4 63 </span>
dan_ackme 11:ea484e1b7fc4 64 </div>
dan_ackme 11:ea484e1b7fc4 65 </li>
dan_ackme 10:735194df0097 66 </ul>
dan_ackme 10:735194df0097 67 </div>
dan_ackme 10:735194df0097 68 <div id="navrow2" class="tabs2">
dan_ackme 10:735194df0097 69 <ul class="tablist">
dan_ackme 10:735194df0097 70 <li class="current"><a href="annotated.html"><span>Class&#160;List</span></a></li>
dan_ackme 10:735194df0097 71 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
dan_ackme 11:ea484e1b7fc4 72 <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
dan_ackme 10:735194df0097 73 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
dan_ackme 10:735194df0097 74 </ul>
dan_ackme 10:735194df0097 75 </div>
dan_ackme 10:735194df0097 76 </div><!-- top -->
dan_ackme 10:735194df0097 77 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 10:735194df0097 78 <div id="nav-tree">
dan_ackme 10:735194df0097 79 <div id="nav-tree-contents">
dan_ackme 10:735194df0097 80 <div id="nav-sync" class="sync"></div>
dan_ackme 10:735194df0097 81 </div>
dan_ackme 10:735194df0097 82 </div>
dan_ackme 10:735194df0097 83 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 10:735194df0097 84 class="ui-resizable-handle">
dan_ackme 10:735194df0097 85 </div>
dan_ackme 10:735194df0097 86 </div>
dan_ackme 10:735194df0097 87 <script type="text/javascript">
dan_ackme 10:735194df0097 88 $(document).ready(function(){initNavTree('annotated.html','');});
dan_ackme 10:735194df0097 89 </script>
dan_ackme 10:735194df0097 90 <div id="doc-content">
dan_ackme 11:ea484e1b7fc4 91 <!-- window showing the filter options -->
dan_ackme 11:ea484e1b7fc4 92 <div id="MSearchSelectWindow"
dan_ackme 11:ea484e1b7fc4 93 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 11:ea484e1b7fc4 94 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 11:ea484e1b7fc4 95 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 11:ea484e1b7fc4 96 <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 97
dan_ackme 11:ea484e1b7fc4 98 <!-- iframe showing the search results (closed by default) -->
dan_ackme 11:ea484e1b7fc4 99 <div id="MSearchResultsWindow">
dan_ackme 11:ea484e1b7fc4 100 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 11:ea484e1b7fc4 101 name="MSearchResults" id="MSearchResults">
dan_ackme 11:ea484e1b7fc4 102 </iframe>
dan_ackme 11:ea484e1b7fc4 103 </div>
dan_ackme 11:ea484e1b7fc4 104
dan_ackme 10:735194df0097 105 <div class="header">
dan_ackme 10:735194df0097 106 <div class="headertitle">
dan_ackme 10:735194df0097 107 <div class="title">Class List</div> </div>
dan_ackme 10:735194df0097 108 </div><!--header-->
dan_ackme 10:735194df0097 109 <div class="contents">
dan_ackme 10:735194df0097 110 <div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
dan_ackme 10:735194df0097 111 <div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
dan_ackme 11:ea484e1b7fc4 112 <tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacewiconnect.html" target="_self">wiconnect</a></td><td class="desc">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 </td></tr>
dan_ackme 11:ea484e1b7fc4 113 <tr id="row_0_0_"><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___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>
dan_ackme 11:ea484e1b7fc4 114 <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="structwiconnect_1_1_buffer.html" target="_self">Buffer</a></td><td class="desc">Generic buffer type </td></tr>
dan_ackme 11:ea484e1b7fc4 115 <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_callback.html" target="_self">Callback</a></td><td class="desc">Generic callback function </td></tr>
dan_ackme 11:ea484e1b7fc4 116 <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_command_queue.html" target="_self">CommandQueue</a></td><td class="desc"></td></tr>
dan_ackme 11:ea484e1b7fc4 117 <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="classwiconnect_1_1_file.html" target="_self">File</a></td><td class="desc">WiConnect WiFi module file object </td></tr>
dan_ackme 11:ea484e1b7fc4 118 <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_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>
dan_ackme 11:ea484e1b7fc4 119 <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_file_list.html" target="_self">FileList</a></td><td class="desc">WiConnect WiFi module file listing </td></tr>
dan_ackme 11:ea484e1b7fc4 120 <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_function_pointer.html" target="_self">FunctionPointer</a></td><td class="desc">Generic function pointer </td></tr>
dan_ackme 11:ea484e1b7fc4 121 <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="structwiconnect_1_1_http_socket_args.html" target="_self">HttpSocketArgs</a></td><td class="desc">Struct for hold HTTP socket configuration </td></tr>
dan_ackme 11:ea484e1b7fc4 122 <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_log_func.html" target="_self">LogFunc</a></td><td class="desc">Logging callback function </td></tr>
dan_ackme 11:ea484e1b7fc4 123 <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="structwiconnect_1_1_mac_address.html" target="_self">MacAddress</a></td><td class="desc">Network MAC Address type </td></tr>
dan_ackme 11:ea484e1b7fc4 124 <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_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>
dan_ackme 11:ea484e1b7fc4 125 <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_queued_command.html" target="_self">QueuedCommand</a></td><td class="desc">Class which contains command for asynchronous processing </td></tr>
dan_ackme 11:ea484e1b7fc4 126 <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_reader_func.html" target="_self">ReaderFunc</a></td><td class="desc">Generic data reading callback function </td></tr>
dan_ackme 11:ea484e1b7fc4 127 <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_scan_result.html" target="_self">ScanResult</a></td><td class="desc">Contains single entry from WiFi scan results </td></tr>
dan_ackme 11:ea484e1b7fc4 128 <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_list.html" target="_self">ScanResultList</a></td><td class="desc">List of WiFi network scan results </td></tr>
dan_ackme 11:ea484e1b7fc4 129 <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_socket.html" target="_self">Socket</a></td><td class="desc">Connection object to remote server </td></tr>
dan_ackme 11:ea484e1b7fc4 130 <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_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>
dan_ackme 11:ea484e1b7fc4 131 <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_irq_handler_map.html" target="_self">SocketIrqHandlerMap</a></td><td class="desc"></td></tr>
dan_ackme 11:ea484e1b7fc4 132 <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>
dan_ackme 11:ea484e1b7fc4 133 <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_timeout_timer.html" target="_self">TimeoutTimer</a></td><td class="desc"></td></tr>
dan_ackme 11:ea484e1b7fc4 134 <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.html" target="_self">Wiconnect</a></td><td class="desc">The root WiConnect library class. This class inheriets all WiConnect functionality </td></tr>
dan_ackme 11:ea484e1b7fc4 135 <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_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" target="_self">WICONNECT_EXTERNAL_INTERRUPT_GPIO_BASE_CLASS</a></td><td class="desc"></td></tr>
dan_ackme 11:ea484e1b7fc4 136 <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_w_i_c_o_n_n_e_c_t___g_p_i_o___b_a_s_e___c_l_a_s_s.html" target="_self">WICONNECT_GPIO_BASE_CLASS</a></td><td class="desc"></td></tr>
dan_ackme 11:ea484e1b7fc4 137 <tr id="row_0_24_"><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_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" target="_self">WICONNECT_PERIODIC_TIMER_BASE_CLASS</a></td><td class="desc"></td></tr>
dan_ackme 11:ea484e1b7fc4 138 <tr id="row_0_25_" 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_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" target="_self">WICONNECT_SERIAL_BASE_CLASS</a></td><td class="desc"></td></tr>
dan_ackme 10:735194df0097 139 </table>
dan_ackme 10:735194df0097 140 </div><!-- directory -->
dan_ackme 10:735194df0097 141 </div><!-- contents -->
dan_ackme 10:735194df0097 142 </div><!-- doc-content -->
dan_ackme 10:735194df0097 143 <!-- start footer part -->
dan_ackme 10:735194df0097 144 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 10:735194df0097 145 <ul>
dan_ackme 11:ea484e1b7fc4 146 <li class="footer">Generated on Tue Aug 12 2014 02:15:27 for WiConnect Library by
dan_ackme 10:735194df0097 147 <a href="http://www.doxygen.org/index.html">
dan_ackme 10:735194df0097 148 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
dan_ackme 10:735194df0097 149 </ul>
dan_ackme 10:735194df0097 150 </div>
dan_ackme 10:735194df0097 151 </body>
dan_ackme 10:735194df0097 152 </html>