ACKme
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/group__api__ghm__types.html
- Committer:
- dan_ackme
- Date:
- 2014-10-27
- Revision:
- 29:b6af04b77a56
File content as of revision 29:b6af04b77a56:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>ACKme WiConnect Host Library</title>
<link rel="icon" href="favicon.ico" type="image/x-icon">
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea" style="font-family:verdana;">
<table border='0' cellpadding='0' cellspacing='0' width="98%">
<tr style="height:20px"><td> </td></tr>
<tr style="border-collapse: collapse; padding: 0;">
<td style="width:20px"></td>
<td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
<td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
WiConnect Host Library- API Reference Guide</td>
<td style="width:20px"></td>
</tr>
<tr><td> </td></tr>
</table>
</div><!-- Generated by Doxygen 1.8.7 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Library Overview</span></a></li>
<li><a href="modules.html"><span>Library API</span></a></li>
<li><a href="examples.html"><span>API Examples</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect Reference Manual</span></a></li>
<li><a href="http://www.ack.me/WiConnect"><span>ACKme Website</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__api__ghm__types.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">Types<div class="ingroups"><a class="el" href="group__api__ghm.html">goHACK.me</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>goHACK.me Types
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_ghm_interface.html">wiconnect::GhmInterface</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The provides an interface for <a href="http://goHACK.me">http://goHACK.me</a>. <a href="classwiconnect_1_1_ghm_interface.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structwiconnect_1_1_ghm_element.html">wiconnect::GhmElement</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">goHACK.me stream or control value <a href="structwiconnect_1_1_ghm_element.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structwiconnect_1_1_ghm_element_array.html">wiconnect::GhmElementArray</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Array of goHACK.me stream or control values. <a href="structwiconnect_1_1_ghm_element_array.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_ghm_message.html">wiconnect::GhmMessage</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Contains single entry from goHACK.me message listing. <a href="classwiconnect_1_1_ghm_message.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_ghm_message_list.html">wiconnect::GhmMessageList</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">List of goHACK.me messages. <a href="classwiconnect_1_1_ghm_message_list.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga4174104f02851ee92e51846877706e67"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4174104f02851ee92e51846877706e67"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__types.html#ga4174104f02851ee92e51846877706e67">wiconnect::GhmElementValueType</a> </td></tr>
<tr class="memdesc:ga4174104f02851ee92e51846877706e67"><td class="mdescLeft"> </td><td class="mdescRight">goHACK.me stream or control value type <br /></td></tr>
<tr class="separator:ga4174104f02851ee92e51846877706e67"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga44ea17651dcf42ac9816f549beb577ac"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__types.html#ga44ea17651dcf42ac9816f549beb577ac">wiconnect::GhmSyncType</a> { <br />
  <a class="el" href="group__api__ghm__types.html#gga44ea17651dcf42ac9816f549beb577aca8aa4d4efd897cd69e0f08feaeaa122e7">wiconnect::GHM_SYNC_ALL</a>,
<br />
  <a class="el" href="group__api__ghm__types.html#gga44ea17651dcf42ac9816f549beb577acafcf2af6407845b24a3abac79587243e0">wiconnect::GHM_SYNC_PUSH_ONLY</a>,
<br />
  <a class="el" href="group__api__ghm__types.html#gga44ea17651dcf42ac9816f549beb577acaad5fbcfa42d14a2662bc5a517c108bdd">wiconnect::GHM_SYNC_PULL_ONLY</a>
<br />
}</td></tr>
<tr class="memdesc:ga44ea17651dcf42ac9816f549beb577ac"><td class="mdescLeft"> </td><td class="mdescRight">goHACK.me sychronization type <a href="group__api__ghm__types.html#ga44ea17651dcf42ac9816f549beb577ac">More...</a><br /></td></tr>
<tr class="separator:ga44ea17651dcf42ac9816f549beb577ac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf75750bfef61c73f9e4677e9de663df1"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__types.html#gaf75750bfef61c73f9e4677e9de663df1">wiconnect::GhmMessageGetType</a> { <br />
  <a class="el" href="group__api__ghm__types.html#ggaf75750bfef61c73f9e4677e9de663df1a7b67ad45967438f44f6942968fb72127">wiconnect::GHM_MSG_GET_DATA_ONLY</a>,
<br />
  <a class="el" href="group__api__ghm__types.html#ggaf75750bfef61c73f9e4677e9de663df1a19876ca1d097b96c48a1e8b54ee562d1">wiconnect::GHM_MSG_GET_BODY</a>,
<br />
  <a class="el" href="group__api__ghm__types.html#ggaf75750bfef61c73f9e4677e9de663df1adcf75ccabf6676b9b8f3050080f4bab7">wiconnect::GHM_MSG_GET_ALL</a>
<br />
}</td></tr>
<tr class="memdesc:gaf75750bfef61c73f9e4677e9de663df1"><td class="mdescLeft"> </td><td class="mdescRight">goHACK.me message GET type <a href="group__api__ghm__types.html#gaf75750bfef61c73f9e4677e9de663df1">More...</a><br /></td></tr>
<tr class="separator:gaf75750bfef61c73f9e4677e9de663df1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>goHACK.me Types </p>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="gaf75750bfef61c73f9e4677e9de663df1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__api__ghm__types.html#gaf75750bfef61c73f9e4677e9de663df1">wiconnect::GhmMessageGetType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>goHACK.me message GET type </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggaf75750bfef61c73f9e4677e9de663df1a7b67ad45967438f44f6942968fb72127"></a>GHM_MSG_GET_DATA_ONLY </td><td class="fielddoc">
<p>Only GET the message data. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggaf75750bfef61c73f9e4677e9de663df1a19876ca1d097b96c48a1e8b54ee562d1"></a>GHM_MSG_GET_BODY </td><td class="fielddoc">
<p>Get the message body. This is JSON formatted. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ggaf75750bfef61c73f9e4677e9de663df1adcf75ccabf6676b9b8f3050080f4bab7"></a>GHM_MSG_GET_ALL </td><td class="fielddoc">
<p>Get entire message. This includes headers. Is JSON formatted. </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="_wiconnect_types_8h_source.html#l00472">472</a> of file <a class="el" href="_wiconnect_types_8h_source.html">WiconnectTypes.h</a>.</p>
</div>
</div>
<a class="anchor" id="ga44ea17651dcf42ac9816f549beb577ac"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__api__ghm__types.html#ga44ea17651dcf42ac9816f549beb577ac">wiconnect::GhmSyncType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>goHACK.me sychronization type </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga44ea17651dcf42ac9816f549beb577aca8aa4d4efd897cd69e0f08feaeaa122e7"></a>GHM_SYNC_ALL </td><td class="fielddoc">
<p>Push and pull all streams and controls. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga44ea17651dcf42ac9816f549beb577acafcf2af6407845b24a3abac79587243e0"></a>GHM_SYNC_PUSH_ONLY </td><td class="fielddoc">
<p>Only push streams and controls to remote server. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga44ea17651dcf42ac9816f549beb577acaad5fbcfa42d14a2662bc5a517c108bdd"></a>GHM_SYNC_PULL_ONLY </td><td class="fielddoc">
<p>Only pull controls from remote server. </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="_wiconnect_types_8h_source.html#l00461">461</a> of file <a class="el" href="_wiconnect_types_8h_source.html">WiconnectTypes.h</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">© ACKme Networks 2014</li>
</ul>
</div>
</body>
</html>
Repository toolbox
| Export to desktop IDE |
Repository details
| Type: | Library |
|---|---|
| Created: | 11 Aug 2014 |
| Imports: | 190 |
| Forks: | 0 |
| Commits: | 43 |
| Dependents: | 10 |
| Dependencies: | 0 |
| Followers: | 25 |
Components
AMW006-A02