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/mbed/html/annotated.html@42:8ffb253b09e7, 2015-09-28 (annotated)

Committer:
aymangrais
Date:
Mon Sep 28 03:38:43 2015 +0000
Revision:
42:8ffb253b09e7
Parent:
34:2616445d0823 
increase ota timeout to be 5 seconds (instead of 1.5 sec)

Who changed what in which revision?

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