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/_timeout_timer_8h_source.html@14:85a2ed029f37, 2014-08-13 (annotated)

Committer:
dan_ackme
Date:
Wed Aug 13 03:14:43 2014 -0700
Revision:
14:85a2ed029f37
Child:
16:7f1d6d359787
doc updates

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 14:85a2ed029f37 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
dan_ackme 14:85a2ed029f37 2 <html xmlns="http://www.w3.org/1999/xhtml">
dan_ackme 14:85a2ed029f37 3 <head>
dan_ackme 14:85a2ed029f37 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
dan_ackme 14:85a2ed029f37 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
dan_ackme 14:85a2ed029f37 6 <title>ACKme WiConnect Host Library</title>
dan_ackme 14:85a2ed029f37 7 <link rel="icon" href="favicon.ico" type="image/x-icon">
dan_ackme 14:85a2ed029f37 8 <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
dan_ackme 14:85a2ed029f37 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 14:85a2ed029f37 10 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 14:85a2ed029f37 11 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 14:85a2ed029f37 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 14:85a2ed029f37 13 <script type="text/javascript" src="resize.js"></script>
dan_ackme 14:85a2ed029f37 14 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 14:85a2ed029f37 15 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 16 $(document).ready(initResizable);
dan_ackme 14:85a2ed029f37 17 $(window).load(resizeHeight);
dan_ackme 14:85a2ed029f37 18 </script>
dan_ackme 14:85a2ed029f37 19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 14:85a2ed029f37 20 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 14:85a2ed029f37 21 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 22 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 14:85a2ed029f37 23 </script>
dan_ackme 14:85a2ed029f37 24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 14:85a2ed029f37 25 </head>
dan_ackme 14:85a2ed029f37 26 <body>
dan_ackme 14:85a2ed029f37 27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 14:85a2ed029f37 28 <div id="titlearea" style="font-family:verdana;">
dan_ackme 14:85a2ed029f37 29 <table border='0' cellpadding='0' cellspacing='0' width="98%">
dan_ackme 14:85a2ed029f37 30 <tr style="height:20px"><td>&nbsp;</td></tr>
dan_ackme 14:85a2ed029f37 31 <tr style="border-collapse: collapse; padding: 0;">
dan_ackme 14:85a2ed029f37 32 <td style="width:20px"></td>
dan_ackme 14:85a2ed029f37 33 <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
dan_ackme 14:85a2ed029f37 34 <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
dan_ackme 14:85a2ed029f37 35 WiConnect Host Library- API Reference Guide</td>
dan_ackme 14:85a2ed029f37 36 <td style="width:20px"></td>
dan_ackme 14:85a2ed029f37 37 </tr>
dan_ackme 14:85a2ed029f37 38 <tr><td>&nbsp;</td></tr>
dan_ackme 14:85a2ed029f37 39 </table>
dan_ackme 14:85a2ed029f37 40 </div><!-- Generated by Doxygen 1.8.7 -->
dan_ackme 14:85a2ed029f37 41 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 42 var searchBox = new SearchBox("searchBox", "search",false,'Search');
dan_ackme 14:85a2ed029f37 43 </script>
dan_ackme 14:85a2ed029f37 44 <div id="navrow1" class="tabs">
dan_ackme 14:85a2ed029f37 45 <ul class="tablist">
dan_ackme 14:85a2ed029f37 46 <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
dan_ackme 14:85a2ed029f37 47 <li><a href="modules.html"><span>Library&#160;API</span></a></li>
dan_ackme 14:85a2ed029f37 48 <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
dan_ackme 14:85a2ed029f37 49 <li><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 14:85a2ed029f37 50 <li><a href="http://wiconnect.ack.me/1.2/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
dan_ackme 14:85a2ed029f37 51 <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
dan_ackme 14:85a2ed029f37 52 <li>
dan_ackme 14:85a2ed029f37 53 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 14:85a2ed029f37 54 <span class="left">
dan_ackme 14:85a2ed029f37 55 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 14:85a2ed029f37 56 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 14:85a2ed029f37 57 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 14:85a2ed029f37 58 alt=""/>
dan_ackme 14:85a2ed029f37 59 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 14:85a2ed029f37 60 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 14:85a2ed029f37 61 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 14:85a2ed029f37 62 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 14:85a2ed029f37 63 </span><span class="right">
dan_ackme 14:85a2ed029f37 64 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 14:85a2ed029f37 65 </span>
dan_ackme 14:85a2ed029f37 66 </div>
dan_ackme 14:85a2ed029f37 67 </li>
dan_ackme 14:85a2ed029f37 68 </ul>
dan_ackme 14:85a2ed029f37 69 </div>
dan_ackme 14:85a2ed029f37 70 </div><!-- top -->
dan_ackme 14:85a2ed029f37 71 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 14:85a2ed029f37 72 <div id="nav-tree">
dan_ackme 14:85a2ed029f37 73 <div id="nav-tree-contents">
dan_ackme 14:85a2ed029f37 74 <div id="nav-sync" class="sync"></div>
dan_ackme 14:85a2ed029f37 75 </div>
dan_ackme 14:85a2ed029f37 76 </div>
dan_ackme 14:85a2ed029f37 77 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 14:85a2ed029f37 78 class="ui-resizable-handle">
dan_ackme 14:85a2ed029f37 79 </div>
dan_ackme 14:85a2ed029f37 80 </div>
dan_ackme 14:85a2ed029f37 81 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 82 $(document).ready(function(){initNavTree('_timeout_timer_8h_source.html','');});
dan_ackme 14:85a2ed029f37 83 </script>
dan_ackme 14:85a2ed029f37 84 <div id="doc-content">
dan_ackme 14:85a2ed029f37 85 <!-- window showing the filter options -->
dan_ackme 14:85a2ed029f37 86 <div id="MSearchSelectWindow"
dan_ackme 14:85a2ed029f37 87 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 14:85a2ed029f37 88 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 14:85a2ed029f37 89 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 14:85a2ed029f37 90 <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 14:85a2ed029f37 91
dan_ackme 14:85a2ed029f37 92 <!-- iframe showing the search results (closed by default) -->
dan_ackme 14:85a2ed029f37 93 <div id="MSearchResultsWindow">
dan_ackme 14:85a2ed029f37 94 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 14:85a2ed029f37 95 name="MSearchResults" id="MSearchResults">
dan_ackme 14:85a2ed029f37 96 </iframe>
dan_ackme 14:85a2ed029f37 97 </div>
dan_ackme 14:85a2ed029f37 98
dan_ackme 14:85a2ed029f37 99 <div class="header">
dan_ackme 14:85a2ed029f37 100 <div class="headertitle">
dan_ackme 14:85a2ed029f37 101 <div class="title">TimeoutTimer.h</div> </div>
dan_ackme 14:85a2ed029f37 102 </div><!--header-->
dan_ackme 14:85a2ed029f37 103 <div class="contents">
dan_ackme 14:85a2ed029f37 104 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
dan_ackme 14:85a2ed029f37 105 <div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright 2014, ACKme Networks</span></div>
dan_ackme 14:85a2ed029f37 106 <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * All Rights Reserved.</span></div>
dan_ackme 14:85a2ed029f37 107 <div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div>
dan_ackme 14:85a2ed029f37 108 <div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * This is UNPUBLISHED PROPRIETARY SOURCE CODE of ACKme Networks;</span></div>
dan_ackme 14:85a2ed029f37 109 <div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * the contents of this file may not be disclosed to third parties, copied</span></div>
dan_ackme 14:85a2ed029f37 110 <div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * or duplicated in any form, in whole or in part, without the prior</span></div>
dan_ackme 14:85a2ed029f37 111 <div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * written permission of ACKme Networks.</span></div>
dan_ackme 14:85a2ed029f37 112 <div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> */</span></div>
dan_ackme 14:85a2ed029f37 113 <div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;</div>
dan_ackme 14:85a2ed029f37 114 <div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#pragma once</span></div>
dan_ackme 14:85a2ed029f37 115 <div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div>
dan_ackme 14:85a2ed029f37 116 <div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div>
dan_ackme 14:85a2ed029f37 117 <div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="keyword">namespace </span>wiconnect</div>
dan_ackme 14:85a2ed029f37 118 <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;{</div>
dan_ackme 14:85a2ed029f37 119 <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div>
dan_ackme 14:85a2ed029f37 120 <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">class </span>TimeoutTimer</div>
dan_ackme 14:85a2ed029f37 121 <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;{</div>
dan_ackme 14:85a2ed029f37 122 <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">public</span>:</div>
dan_ackme 14:85a2ed029f37 123 <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; TimeoutTimer();</div>
dan_ackme 14:85a2ed029f37 124 <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div>
dan_ackme 14:85a2ed029f37 125 <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordtype">void</span> reset(<span class="keywordtype">void</span>);</div>
dan_ackme 14:85a2ed029f37 126 <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div>
dan_ackme 14:85a2ed029f37 127 <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; uint32_t remainingMs(uint32_t timeoutMs);</div>
dan_ackme 14:85a2ed029f37 128 <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; uint32_t readUs();</div>
dan_ackme 14:85a2ed029f37 129 <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
dan_ackme 14:85a2ed029f37 130 <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordtype">bool</span> timedOut(uint32_t timeoutMs);</div>
dan_ackme 14:85a2ed029f37 131 <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
dan_ackme 14:85a2ed029f37 132 <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">protected</span>:</div>
dan_ackme 14:85a2ed029f37 133 <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; uint32_t _start;</div>
dan_ackme 14:85a2ed029f37 134 <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div>
dan_ackme 14:85a2ed029f37 135 <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;};</div>
dan_ackme 14:85a2ed029f37 136 <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
dan_ackme 14:85a2ed029f37 137 <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div>
dan_ackme 14:85a2ed029f37 138 <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;}</div>
dan_ackme 14:85a2ed029f37 139 </div><!-- fragment --></div><!-- contents -->
dan_ackme 14:85a2ed029f37 140 </div><!-- doc-content -->
dan_ackme 14:85a2ed029f37 141 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 14:85a2ed029f37 142 <ul>
dan_ackme 14:85a2ed029f37 143 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 14:85a2ed029f37 144 </ul>
dan_ackme 14:85a2ed029f37 145 </div>
dan_ackme 14:85a2ed029f37 146 </body>
dan_ackme 14:85a2ed029f37 147 </html>