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/classwiconnect_1_1_ghm_interface-members.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 class="current"><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 id="navrow2" class="tabs2">
dan_ackme 29:b6af04b77a56 71 <ul class="tablist">
dan_ackme 29:b6af04b77a56 72 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
dan_ackme 29:b6af04b77a56 73 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
dan_ackme 29:b6af04b77a56 74 <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
dan_ackme 29:b6af04b77a56 75 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
dan_ackme 29:b6af04b77a56 76 </ul>
dan_ackme 29:b6af04b77a56 77 </div>
dan_ackme 29:b6af04b77a56 78 </div><!-- top -->
dan_ackme 29:b6af04b77a56 79 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 29:b6af04b77a56 80 <div id="nav-tree">
dan_ackme 29:b6af04b77a56 81 <div id="nav-tree-contents">
dan_ackme 29:b6af04b77a56 82 <div id="nav-sync" class="sync"></div>
dan_ackme 29:b6af04b77a56 83 </div>
dan_ackme 29:b6af04b77a56 84 </div>
dan_ackme 29:b6af04b77a56 85 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 29:b6af04b77a56 86 class="ui-resizable-handle">
dan_ackme 29:b6af04b77a56 87 </div>
dan_ackme 29:b6af04b77a56 88 </div>
dan_ackme 29:b6af04b77a56 89 <script type="text/javascript">
dan_ackme 29:b6af04b77a56 90 $(document).ready(function(){initNavTree('classwiconnect_1_1_ghm_interface.html','');});
dan_ackme 29:b6af04b77a56 91 </script>
dan_ackme 29:b6af04b77a56 92 <div id="doc-content">
dan_ackme 29:b6af04b77a56 93 <!-- window showing the filter options -->
dan_ackme 29:b6af04b77a56 94 <div id="MSearchSelectWindow"
dan_ackme 29:b6af04b77a56 95 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 29:b6af04b77a56 96 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 29:b6af04b77a56 97 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 29:b6af04b77a56 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 29:b6af04b77a56 99
dan_ackme 29:b6af04b77a56 100 <!-- iframe showing the search results (closed by default) -->
dan_ackme 29:b6af04b77a56 101 <div id="MSearchResultsWindow">
dan_ackme 29:b6af04b77a56 102 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 29:b6af04b77a56 103 name="MSearchResults" id="MSearchResults">
dan_ackme 29:b6af04b77a56 104 </iframe>
dan_ackme 29:b6af04b77a56 105 </div>
dan_ackme 29:b6af04b77a56 106
dan_ackme 29:b6af04b77a56 107 <div class="header">
dan_ackme 29:b6af04b77a56 108 <div class="headertitle">
dan_ackme 29:b6af04b77a56 109 <div class="title">wiconnect::GhmInterface Member List</div> </div>
dan_ackme 29:b6af04b77a56 110 </div><!--header-->
dan_ackme 29:b6af04b77a56 111 <div class="contents">
dan_ackme 29:b6af04b77a56 112
dan_ackme 29:b6af04b77a56 113 <p>This is the complete list of members for <a class="el" href="classwiconnect_1_1_ghm_interface.html">wiconnect::GhmInterface</a>, including all inherited members.</p>
dan_ackme 29:b6af04b77a56 114 <table class="directory">
dan_ackme 29:b6af04b77a56 115 <tr class="even"><td class="entry"><a class="el" href="group__api__ghm__activate.html#gaa0213731eebd4a14e9099d01ff76beff">ghmActivate</a>(const char *userName, const char *password, const char *capsFilename=NULL)</td><td class="entry"><a class="el" href="classwiconnect_1_1_ghm_interface.html">wiconnect::GhmInterface</a></td><td class="entry"></td></tr>
dan_ackme 29:b6af04b77a56 116 <tr><td class="entry"><a class="el" href="group__api__ghm__activate.html#gad0e0484d1f9a6608475874544f96708b">ghmDeactivate</a>(const char *userName, const char *password)</td><td class="entry"><a class="el" href="classwiconnect_1_1_ghm_interface.html">wiconnect::GhmInterface</a></td><td class="entry"></td></tr>
dan_ackme 29:b6af04b77a56 117 <tr class="even"><td class="entry"><a class="el" href="group__api__ghm__msg.html#ga451de9d69f7ecbf38e36056e502b94b0">ghmDeleteMessage</a>(uint8_t listIndex)</td><td class="entry"><a class="el" href="classwiconnect_1_1_ghm_interface.html">wiconnect::GhmInterface</a></td><td class="entry"></td></tr>
dan_ackme 29:b6af04b77a56 118 <tr><td class="entry"><a class="el" href="group__api__ghm__msg.html#ga7273f4c691aeccd241327f1be3e8d0e9">ghmDeleteMessage</a>(const char *msgId)</td><td class="entry"><a class="el" href="classwiconnect_1_1_ghm_interface.html">wiconnect::GhmInterface</a></td><td class="entry"></td></tr>
dan_ackme 29:b6af04b77a56 119 <tr class="even"><td class="entry"><a class="el" href="group__api__ghm__activate.html#gaff03ecaa08146e6925820209cdab56bd">ghmDownloadCapabilities</a>(const char *capsNameOrCustomUrl=NULL, uint32_t version=0)</td><td class="entry"><a class="el" href="classwiconnect_1_1_ghm_interface.html">wiconnect::GhmInterface</a></td><td class="entry"></td></tr>
dan_ackme 29:b6af04b77a56 120 <tr><td class="entry"><a class="el" href="group__api__ghm__msg.html#gaaa05391432b2ca38bb416c671f57b234">ghmGetMessage</a>(WiconnectSocket &amp;socket, GhmMessageGetType getType=GHM_MSG_GET_DATA_ONLY)</td><td class="entry"><a class="el" href="classwiconnect_1_1_ghm_interface.html">wiconnect::GhmInterface</a></td><td class="entry"></td></tr>
dan_ackme 29:b6af04b77a56 121 <tr class="even"><td class="entry"><a class="el" href="group__api__ghm__msg.html#gaa905a010f0e234d290eaef6e42975c29">ghmGetMessage</a>(WiconnectSocket &amp;socket, uint8_t listIndex, GhmMessageGetType getType=GHM_MSG_GET_DATA_ONLY)</td><td class="entry"><a class="el" href="classwiconnect_1_1_ghm_interface.html">wiconnect::GhmInterface</a></td><td class="entry"></td></tr>
dan_ackme 29:b6af04b77a56 122 <tr><td class="entry"><a class="el" href="group__api__ghm__msg.html#ga9c6dffaa871f2443a32d75276160682d">ghmGetMessage</a>(WiconnectSocket &amp;socket, const char *msgId, GhmMessageGetType getType=GHM_MSG_GET_DATA_ONLY)</td><td class="entry"><a class="el" href="classwiconnect_1_1_ghm_interface.html">wiconnect::GhmInterface</a></td><td class="entry"></td></tr>
dan_ackme 29:b6af04b77a56 123 <tr class="even"><td class="entry"><a class="el" href="group__api__ghm__activate.html#ga8bec70f780ca7de9dce1a15830c179ff">ghmIsActivated</a>(bool *statusPtr)</td><td class="entry"><a class="el" href="classwiconnect_1_1_ghm_interface.html">wiconnect::GhmInterface</a></td><td class="entry"></td></tr>
dan_ackme 29:b6af04b77a56 124 <tr><td class="entry"><a class="el" href="group__api__ghm__msg.html#gae69971594793e1a10f11a51277909502">ghmListMessages</a>(GhmMessageList &amp;msgList, uint8_t maxCount=0)</td><td class="entry"><a class="el" href="classwiconnect_1_1_ghm_interface.html">wiconnect::GhmInterface</a></td><td class="entry"></td></tr>
dan_ackme 29:b6af04b77a56 125 <tr class="even"><td class="entry"><a class="el" href="group__api__ghm__msg.html#gadc281f497041b26a151c72a0b5d03543">ghmPostMessage</a>(WiconnectSocket &amp;socket, bool jsonFormatted=false)</td><td class="entry"><a class="el" href="classwiconnect_1_1_ghm_interface.html">wiconnect::GhmInterface</a></td><td class="entry"></td></tr>
dan_ackme 29:b6af04b77a56 126 <tr><td class="entry"><a class="el" href="group__api__ghm__com.html#ga3fde7b34da992719b41fc52178b73bc2">ghmRead</a>(const char *controlName, const char **valueStrPtr)</td><td class="entry"><a class="el" href="classwiconnect_1_1_ghm_interface.html">wiconnect::GhmInterface</a></td><td class="entry"></td></tr>
dan_ackme 29:b6af04b77a56 127 <tr class="even"><td class="entry"><a class="el" href="group__api__ghm__com.html#ga2d4f14ef409c30b49ce2a06b72d10c7f">ghmRead</a>(const char *controlName, uint32_t *valueIntPtr)</td><td class="entry"><a class="el" href="classwiconnect_1_1_ghm_interface.html">wiconnect::GhmInterface</a></td><td class="entry"></td></tr>
dan_ackme 29:b6af04b77a56 128 <tr><td class="entry"><a class="el" href="group__api__ghm__com.html#ga965090d4b28bda9f58716b522a6bee12">ghmRead</a>(const char *controlName, char *valueBuffer, uint16_t valueBufferLen)</td><td class="entry"><a class="el" href="classwiconnect_1_1_ghm_interface.html">wiconnect::GhmInterface</a></td><td class="entry"></td></tr>
dan_ackme 29:b6af04b77a56 129 <tr class="even"><td class="entry"><a class="el" href="group__api__ghm__com.html#ga0aa48506edb22c90be513683672b96c7">ghmSynchronize</a>(GhmSyncType type=GHM_SYNC_ALL)</td><td class="entry"><a class="el" href="classwiconnect_1_1_ghm_interface.html">wiconnect::GhmInterface</a></td><td class="entry"></td></tr>
dan_ackme 29:b6af04b77a56 130 <tr><td class="entry"><a class="el" href="group__api__ghm__com.html#ga2f57fc33ad0e71d608b1350d4e3ab223">ghmWrite</a>(const char *elementName, const char *strValue)</td><td class="entry"><a class="el" href="classwiconnect_1_1_ghm_interface.html">wiconnect::GhmInterface</a></td><td class="entry"></td></tr>
dan_ackme 29:b6af04b77a56 131 <tr class="even"><td class="entry"><a class="el" href="group__api__ghm__com.html#ga26ef47c451e7dbe869f19f5f36695e7c">ghmWrite</a>(const char *elementName, uint32_t uintValue)</td><td class="entry"><a class="el" href="classwiconnect_1_1_ghm_interface.html">wiconnect::GhmInterface</a></td><td class="entry"></td></tr>
dan_ackme 29:b6af04b77a56 132 <tr><td class="entry"><a class="el" href="group__api__ghm__com.html#gab524e64f4bbae826c27bf39d7f2d3c2e">ghmWrite</a>(const char *elementName, int32_t intValue)</td><td class="entry"><a class="el" href="classwiconnect_1_1_ghm_interface.html">wiconnect::GhmInterface</a></td><td class="entry"></td></tr>
dan_ackme 29:b6af04b77a56 133 <tr class="even"><td class="entry"><a class="el" href="group__api__ghm__com.html#ga5eb797aba87a3ab76d742afe34292ee6">ghmWrite</a>(const GhmElementArray *elementArray)</td><td class="entry"><a class="el" href="classwiconnect_1_1_ghm_interface.html">wiconnect::GhmInterface</a></td><td class="entry"></td></tr>
dan_ackme 29:b6af04b77a56 134 </table></div><!-- contents -->
dan_ackme 29:b6af04b77a56 135 </div><!-- doc-content -->
dan_ackme 29:b6af04b77a56 136 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 29:b6af04b77a56 137 <ul>
dan_ackme 29:b6af04b77a56 138 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 29:b6af04b77a56 139 </ul>
dan_ackme 29:b6af04b77a56 140 </div>
dan_ackme 29:b6af04b77a56 141 </body>
dan_ackme 29:b6af04b77a56 142 </html>