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/_ghm_message_list_8h_source.html@29:b6af04b77a56, 2014-10-27 (annotated)

Committer:
dan_ackme
Date:
Mon Oct 27 13:42:26 2014 -0700
Revision:
29:b6af04b77a56
refactored library layout

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 29:b6af04b77a56 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
dan_ackme 29:b6af04b77a56 2 <html xmlns="http://www.w3.org/1999/xhtml">
dan_ackme 29:b6af04b77a56 3 <head>
dan_ackme 29:b6af04b77a56 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
dan_ackme 29:b6af04b77a56 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
dan_ackme 29:b6af04b77a56 6 <title>ACKme WiConnect Host Library</title>
dan_ackme 29:b6af04b77a56 7 <link rel="icon" href="favicon.ico" type="image/x-icon">
dan_ackme 29:b6af04b77a56 8 <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
dan_ackme 29:b6af04b77a56 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 29:b6af04b77a56 10 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 29:b6af04b77a56 11 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 29:b6af04b77a56 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 29:b6af04b77a56 13 <script type="text/javascript" src="resize.js"></script>
dan_ackme 29:b6af04b77a56 14 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 29:b6af04b77a56 15 <script type="text/javascript">
dan_ackme 29:b6af04b77a56 16 $(document).ready(initResizable);
dan_ackme 29:b6af04b77a56 17 $(window).load(resizeHeight);
dan_ackme 29:b6af04b77a56 18 </script>
dan_ackme 29:b6af04b77a56 19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 29:b6af04b77a56 20 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 29:b6af04b77a56 21 <script type="text/javascript">
dan_ackme 29:b6af04b77a56 22 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 29:b6af04b77a56 23 </script>
dan_ackme 29:b6af04b77a56 24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 29:b6af04b77a56 25 </head>
dan_ackme 29:b6af04b77a56 26 <body>
dan_ackme 29:b6af04b77a56 27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 29:b6af04b77a56 28 <div id="titlearea" style="font-family:verdana;">
dan_ackme 29:b6af04b77a56 29 <table border='0' cellpadding='0' cellspacing='0' width="98%">
dan_ackme 29:b6af04b77a56 30 <tr style="height:20px"><td>&nbsp;</td></tr>
dan_ackme 29:b6af04b77a56 31 <tr style="border-collapse: collapse; padding: 0;">
dan_ackme 29:b6af04b77a56 32 <td style="width:20px"></td>
dan_ackme 29:b6af04b77a56 33 <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
dan_ackme 29:b6af04b77a56 34 <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
dan_ackme 29:b6af04b77a56 35 WiConnect Host Library- API Reference Guide</td>
dan_ackme 29:b6af04b77a56 36 <td style="width:20px"></td>
dan_ackme 29:b6af04b77a56 37 </tr>
dan_ackme 29:b6af04b77a56 38 <tr><td>&nbsp;</td></tr>
dan_ackme 29:b6af04b77a56 39 </table>
dan_ackme 29:b6af04b77a56 40 </div><!-- Generated by Doxygen 1.8.7 -->
dan_ackme 29:b6af04b77a56 41 <script type="text/javascript">
dan_ackme 29:b6af04b77a56 42 var searchBox = new SearchBox("searchBox", "search",false,'Search');
dan_ackme 29:b6af04b77a56 43 </script>
dan_ackme 29:b6af04b77a56 44 <div id="navrow1" class="tabs">
dan_ackme 29:b6af04b77a56 45 <ul class="tablist">
dan_ackme 29:b6af04b77a56 46 <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
dan_ackme 29:b6af04b77a56 47 <li><a href="modules.html"><span>Library&#160;API</span></a></li>
dan_ackme 29:b6af04b77a56 48 <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
dan_ackme 29:b6af04b77a56 49 <li><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 29:b6af04b77a56 50 <li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
dan_ackme 29:b6af04b77a56 51 <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
dan_ackme 29:b6af04b77a56 52 <li>
dan_ackme 29:b6af04b77a56 53 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 29:b6af04b77a56 54 <span class="left">
dan_ackme 29:b6af04b77a56 55 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 29:b6af04b77a56 56 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 29:b6af04b77a56 57 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 29:b6af04b77a56 58 alt=""/>
dan_ackme 29:b6af04b77a56 59 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 29:b6af04b77a56 60 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 29:b6af04b77a56 61 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 29:b6af04b77a56 62 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 29:b6af04b77a56 63 </span><span class="right">
dan_ackme 29:b6af04b77a56 64 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 29:b6af04b77a56 65 </span>
dan_ackme 29:b6af04b77a56 66 </div>
dan_ackme 29:b6af04b77a56 67 </li>
dan_ackme 29:b6af04b77a56 68 </ul>
dan_ackme 29:b6af04b77a56 69 </div>
dan_ackme 29:b6af04b77a56 70 </div><!-- top -->
dan_ackme 29:b6af04b77a56 71 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 29:b6af04b77a56 72 <div id="nav-tree">
dan_ackme 29:b6af04b77a56 73 <div id="nav-tree-contents">
dan_ackme 29:b6af04b77a56 74 <div id="nav-sync" class="sync"></div>
dan_ackme 29:b6af04b77a56 75 </div>
dan_ackme 29:b6af04b77a56 76 </div>
dan_ackme 29:b6af04b77a56 77 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 29:b6af04b77a56 78 class="ui-resizable-handle">
dan_ackme 29:b6af04b77a56 79 </div>
dan_ackme 29:b6af04b77a56 80 </div>
dan_ackme 29:b6af04b77a56 81 <script type="text/javascript">
dan_ackme 29:b6af04b77a56 82 $(document).ready(function(){initNavTree('_ghm_message_list_8h_source.html','');});
dan_ackme 29:b6af04b77a56 83 </script>
dan_ackme 29:b6af04b77a56 84 <div id="doc-content">
dan_ackme 29:b6af04b77a56 85 <!-- window showing the filter options -->
dan_ackme 29:b6af04b77a56 86 <div id="MSearchSelectWindow"
dan_ackme 29:b6af04b77a56 87 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 29:b6af04b77a56 88 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 29:b6af04b77a56 89 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 29:b6af04b77a56 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 29:b6af04b77a56 91
dan_ackme 29:b6af04b77a56 92 <!-- iframe showing the search results (closed by default) -->
dan_ackme 29:b6af04b77a56 93 <div id="MSearchResultsWindow">
dan_ackme 29:b6af04b77a56 94 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 29:b6af04b77a56 95 name="MSearchResults" id="MSearchResults">
dan_ackme 29:b6af04b77a56 96 </iframe>
dan_ackme 29:b6af04b77a56 97 </div>
dan_ackme 29:b6af04b77a56 98
dan_ackme 29:b6af04b77a56 99 <div class="header">
dan_ackme 29:b6af04b77a56 100 <div class="headertitle">
dan_ackme 29:b6af04b77a56 101 <div class="title">GhmMessageList.h</div> </div>
dan_ackme 29:b6af04b77a56 102 </div><!--header-->
dan_ackme 29:b6af04b77a56 103 <div class="contents">
dan_ackme 29:b6af04b77a56 104 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div>
dan_ackme 29:b6af04b77a56 105 <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#pragma once</span></div>
dan_ackme 29:b6af04b77a56 106 <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div>
dan_ackme 29:b6af04b77a56 107 <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &quot;api/WiconnectTypes.h&quot;</span></div>
dan_ackme 29:b6af04b77a56 108 <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#include &quot;GhmMessage.h&quot;</span></div>
dan_ackme 29:b6af04b77a56 109 <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
dan_ackme 29:b6af04b77a56 110 <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div>
dan_ackme 29:b6af04b77a56 111 <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
dan_ackme 29:b6af04b77a56 112 <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keyword">namespace </span>wiconnect</div>
dan_ackme 29:b6af04b77a56 113 <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;{</div>
dan_ackme 29:b6af04b77a56 114 <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
dan_ackme 29:b6af04b77a56 115 <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div>
dan_ackme 29:b6af04b77a56 116 <div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classwiconnect_1_1_ghm_message_list.html"> 46</a></span>&#160;<span class="keyword">class </span><a class="code" href="classwiconnect_1_1_ghm_message_list.html">GhmMessageList</a></div>
dan_ackme 29:b6af04b77a56 117 <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;{</div>
dan_ackme 29:b6af04b77a56 118 <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="keyword">public</span>:</div>
dan_ackme 29:b6af04b77a56 119 <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <a class="code" href="classwiconnect_1_1_ghm_message_list.html">GhmMessageList</a>(<span class="keywordtype">int</span> bufferLen = 0, <span class="keywordtype">void</span> *buffer = NULL);</div>
dan_ackme 29:b6af04b77a56 120 <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; ~<a class="code" href="classwiconnect_1_1_ghm_message_list.html">GhmMessageList</a>();</div>
dan_ackme 29:b6af04b77a56 121 <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div>
dan_ackme 29:b6af04b77a56 122 <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordtype">void</span> reset(<span class="keywordtype">void</span>);</div>
dan_ackme 29:b6af04b77a56 123 <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_ghm_message.html">GhmMessage</a>* getListHead() <span class="keyword">const</span>;</div>
dan_ackme 29:b6af04b77a56 124 <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordtype">int</span> getCount() <span class="keyword">const</span>;</div>
dan_ackme 29:b6af04b77a56 125 <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_ghm_message.html">GhmMessage</a>* getResult(<span class="keywordtype">int</span> i) <span class="keyword">const</span>;</div>
dan_ackme 29:b6af04b77a56 126 <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keyword">const</span> <a class="code" href="classwiconnect_1_1_ghm_message.html">GhmMessage</a>* operator [](<span class="keywordtype">int</span> i) <span class="keyword">const</span>;</div>
dan_ackme 29:b6af04b77a56 127 <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;</div>
dan_ackme 29:b6af04b77a56 128 <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="keyword">protected</span>:</div>
dan_ackme 29:b6af04b77a56 129 <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <a class="code" href="classwiconnect_1_1_ghm_message.html">GhmMessage</a> *listHead, *listTail;</div>
dan_ackme 29:b6af04b77a56 130 <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; uint8_t *buffer;</div>
dan_ackme 29:b6af04b77a56 131 <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; uint8_t *bufferPtr;</div>
dan_ackme 29:b6af04b77a56 132 <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; uint16_t bufferLen;</div>
dan_ackme 29:b6af04b77a56 133 <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; uint16_t bufferRemaining;</div>
dan_ackme 29:b6af04b77a56 134 <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordtype">int</span> count;</div>
dan_ackme 29:b6af04b77a56 135 <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div>
dan_ackme 29:b6af04b77a56 136 <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <a class="code" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> add(<span class="keyword">const</span> <span class="keywordtype">char</span> *msgId, <span class="keyword">const</span> <span class="keywordtype">char</span>* timestamp, <span class="keyword">const</span> <span class="keywordtype">char</span> *length);</div>
dan_ackme 29:b6af04b77a56 137 <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div>
dan_ackme 29:b6af04b77a56 138 <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div>
dan_ackme 29:b6af04b77a56 139 <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classwiconnect_1_1_ghm_interface.html">GhmInterface</a>;</div>
dan_ackme 29:b6af04b77a56 140 <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;};</div>
dan_ackme 29:b6af04b77a56 141 <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;</div>
dan_ackme 29:b6af04b77a56 142 <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div>
dan_ackme 29:b6af04b77a56 143 <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;}</div>
dan_ackme 29:b6af04b77a56 144 <div class="ttc" id="classwiconnect_1_1_ghm_message_html"><div class="ttname"><a href="classwiconnect_1_1_ghm_message.html">wiconnect::GhmMessage</a></div><div class="ttdoc">Contains single entry from goHACK.me message listing. </div><div class="ttdef"><b>Definition:</b> <a href="_ghm_message_8h_source.html#l00046">GhmMessage.h:46</a></div></div>
dan_ackme 29:b6af04b77a56 145 <div class="ttc" id="group__api__core__types_html_ga325637ed501728bd6c8c7a7982b9ce05"><div class="ttname"><a href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">wiconnect::WiconnectResult</a></div><div class="ttdeci">WiconnectResult</div><div class="ttdoc">API Result code. </div><div class="ttdef"><b>Definition:</b> <a href="_wiconnect_types_8h_source.html#l00166">WiconnectTypes.h:166</a></div></div>
dan_ackme 29:b6af04b77a56 146 <div class="ttc" id="classwiconnect_1_1_ghm_message_list_html"><div class="ttname"><a href="classwiconnect_1_1_ghm_message_list.html">wiconnect::GhmMessageList</a></div><div class="ttdoc">List of goHACK.me messages. </div><div class="ttdef"><b>Definition:</b> <a href="_ghm_message_list_8h_source.html#l00046">GhmMessageList.h:46</a></div></div>
dan_ackme 29:b6af04b77a56 147 <div class="ttc" id="classwiconnect_1_1_ghm_interface_html"><div class="ttname"><a href="classwiconnect_1_1_ghm_interface.html">wiconnect::GhmInterface</a></div><div class="ttdoc">The provides an interface for http://goHACK.me. </div><div class="ttdef"><b>Definition:</b> <a href="_ghm_interface_8h_source.html#l00081">GhmInterface.h:81</a></div></div>
dan_ackme 29:b6af04b77a56 148 </div><!-- fragment --></div><!-- contents -->
dan_ackme 29:b6af04b77a56 149 </div><!-- doc-content -->
dan_ackme 29:b6af04b77a56 150 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 29:b6af04b77a56 151 <ul>
dan_ackme 29:b6af04b77a56 152 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 29:b6af04b77a56 153 </ul>
dan_ackme 29:b6af04b77a56 154 </div>
dan_ackme 29:b6af04b77a56 155 </body>
dan_ackme 29:b6af04b77a56 156 </html>