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/group__api__ghm__msg.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><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><!-- top -->
dan_ackme 34:2616445d0823 72 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 34:2616445d0823 73 <div id="nav-tree">
dan_ackme 34:2616445d0823 74 <div id="nav-tree-contents">
dan_ackme 34:2616445d0823 75 <div id="nav-sync" class="sync"></div>
dan_ackme 34:2616445d0823 76 </div>
dan_ackme 34:2616445d0823 77 </div>
dan_ackme 34:2616445d0823 78 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 34:2616445d0823 79 class="ui-resizable-handle">
dan_ackme 34:2616445d0823 80 </div>
dan_ackme 34:2616445d0823 81 </div>
dan_ackme 34:2616445d0823 82 <script type="text/javascript">
dan_ackme 34:2616445d0823 83 $(document).ready(function(){initNavTree('group__api__ghm__msg.html','');});
dan_ackme 34:2616445d0823 84 </script>
dan_ackme 34:2616445d0823 85 <div id="doc-content">
dan_ackme 34:2616445d0823 86 <!-- window showing the filter options -->
dan_ackme 34:2616445d0823 87 <div id="MSearchSelectWindow"
dan_ackme 34:2616445d0823 88 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 34:2616445d0823 89 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 34:2616445d0823 90 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 34:2616445d0823 91 <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 92
dan_ackme 34:2616445d0823 93 <!-- iframe showing the search results (closed by default) -->
dan_ackme 34:2616445d0823 94 <div id="MSearchResultsWindow">
dan_ackme 34:2616445d0823 95 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 34:2616445d0823 96 name="MSearchResults" id="MSearchResults">
dan_ackme 34:2616445d0823 97 </iframe>
dan_ackme 34:2616445d0823 98 </div>
dan_ackme 34:2616445d0823 99
dan_ackme 34:2616445d0823 100 <div class="header">
dan_ackme 34:2616445d0823 101 <div class="summary">
dan_ackme 34:2616445d0823 102 <a href="#func-members">Functions</a> </div>
dan_ackme 34:2616445d0823 103 <div class="headertitle">
dan_ackme 34:2616445d0823 104 <div class="title">Message<div class="ingroups"><a class="el" href="group__api__ghm.html">goHACK.me</a></div></div> </div>
dan_ackme 34:2616445d0823 105 </div><!--header-->
dan_ackme 34:2616445d0823 106 <div class="contents">
dan_ackme 34:2616445d0823 107
dan_ackme 34:2616445d0823 108 <p>Methods for getting, posting, listing, deleting messages wtih <a href="http://goHACK.me">http://goHACK.me</a>.
dan_ackme 34:2616445d0823 109 <a href="#details">More...</a></p>
dan_ackme 34:2616445d0823 110 <table class="memberdecls">
dan_ackme 34:2616445d0823 111 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
dan_ackme 34:2616445d0823 112 Functions</h2></td></tr>
dan_ackme 34:2616445d0823 113 <tr class="memitem:gadc281f497041b26a151c72a0b5d03543"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__msg.html#gadc281f497041b26a151c72a0b5d03543">wiconnect::GhmInterface::ghmPostMessage</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, bool jsonFormatted=false)</td></tr>
dan_ackme 34:2616445d0823 114 <tr class="memdesc:gadc281f497041b26a151c72a0b5d03543"><td class="mdescLeft">&#160;</td><td class="mdescRight">POST message to <a href="http://goHACK.me">http://goHACK.me</a>. <a href="#gadc281f497041b26a151c72a0b5d03543">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 115 <tr class="separator:gadc281f497041b26a151c72a0b5d03543"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 116 <tr class="memitem:gaaa05391432b2ca38bb416c671f57b234"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__msg.html#gaaa05391432b2ca38bb416c671f57b234">wiconnect::GhmInterface::ghmGetMessage</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, <a class="el" href="group__api__ghm__types.html#gaf75750bfef61c73f9e4677e9de663df1">GhmMessageGetType</a> getType=GHM_MSG_GET_DATA_ONLY)</td></tr>
dan_ackme 34:2616445d0823 117 <tr class="memdesc:gaaa05391432b2ca38bb416c671f57b234"><td class="mdescLeft">&#160;</td><td class="mdescRight">GET message from <a href="http://goHACK.me">http://goHACK.me</a>. <a href="#gaaa05391432b2ca38bb416c671f57b234">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 118 <tr class="separator:gaaa05391432b2ca38bb416c671f57b234"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 119 <tr class="memitem:gaa905a010f0e234d290eaef6e42975c29"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__msg.html#gaa905a010f0e234d290eaef6e42975c29">wiconnect::GhmInterface::ghmGetMessage</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, uint8_t listIndex, <a class="el" href="group__api__ghm__types.html#gaf75750bfef61c73f9e4677e9de663df1">GhmMessageGetType</a> getType=GHM_MSG_GET_DATA_ONLY)</td></tr>
dan_ackme 34:2616445d0823 120 <tr class="memdesc:gaa905a010f0e234d290eaef6e42975c29"><td class="mdescLeft">&#160;</td><td class="mdescRight">GET message from <a href="http://goHACK.me">http://goHACK.me</a>. <a href="#gaa905a010f0e234d290eaef6e42975c29">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 121 <tr class="separator:gaa905a010f0e234d290eaef6e42975c29"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 122 <tr class="memitem:ga9c6dffaa871f2443a32d75276160682d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__msg.html#ga9c6dffaa871f2443a32d75276160682d">wiconnect::GhmInterface::ghmGetMessage</a> (<a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;socket, const char *msgId, <a class="el" href="group__api__ghm__types.html#gaf75750bfef61c73f9e4677e9de663df1">GhmMessageGetType</a> getType=GHM_MSG_GET_DATA_ONLY)</td></tr>
dan_ackme 34:2616445d0823 123 <tr class="memdesc:ga9c6dffaa871f2443a32d75276160682d"><td class="mdescLeft">&#160;</td><td class="mdescRight">GET message from <a href="http://goHACK.me">http://goHACK.me</a>. <a href="#ga9c6dffaa871f2443a32d75276160682d">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 124 <tr class="separator:ga9c6dffaa871f2443a32d75276160682d"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 125 <tr class="memitem:ga451de9d69f7ecbf38e36056e502b94b0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__msg.html#ga451de9d69f7ecbf38e36056e502b94b0">wiconnect::GhmInterface::ghmDeleteMessage</a> (uint8_t listIndex)</td></tr>
dan_ackme 34:2616445d0823 126 <tr class="memdesc:ga451de9d69f7ecbf38e36056e502b94b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete message from <a href="http://goHACK.me">http://goHACK.me</a>. <a href="#ga451de9d69f7ecbf38e36056e502b94b0">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 127 <tr class="separator:ga451de9d69f7ecbf38e36056e502b94b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 128 <tr class="memitem:ga7273f4c691aeccd241327f1be3e8d0e9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__msg.html#ga7273f4c691aeccd241327f1be3e8d0e9">wiconnect::GhmInterface::ghmDeleteMessage</a> (const char *msgId)</td></tr>
dan_ackme 34:2616445d0823 129 <tr class="memdesc:ga7273f4c691aeccd241327f1be3e8d0e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete message from <a href="http://goHACK.me">http://goHACK.me</a>. <a href="#ga7273f4c691aeccd241327f1be3e8d0e9">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 130 <tr class="separator:ga7273f4c691aeccd241327f1be3e8d0e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 131 <tr class="memitem:gae69971594793e1a10f11a51277909502"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__ghm__msg.html#gae69971594793e1a10f11a51277909502">wiconnect::GhmInterface::ghmListMessages</a> (<a class="el" href="classwiconnect_1_1_ghm_message_list.html">GhmMessageList</a> &amp;msgList, uint8_t maxCount=0)</td></tr>
dan_ackme 34:2616445d0823 132 <tr class="memdesc:gae69971594793e1a10f11a51277909502"><td class="mdescLeft">&#160;</td><td class="mdescRight">List available messages for device on <a href="http://goHACK.me">http://goHACK.me</a>. <a href="#gae69971594793e1a10f11a51277909502">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 133 <tr class="separator:gae69971594793e1a10f11a51277909502"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 134 </table>
dan_ackme 34:2616445d0823 135 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 34:2616445d0823 136 <p>Methods for getting, posting, listing, deleting messages wtih <a href="http://goHACK.me">http://goHACK.me</a>. </p>
dan_ackme 34:2616445d0823 137 <h2 class="groupheader">Function Documentation</h2>
dan_ackme 34:2616445d0823 138 <a class="anchor" id="ga451de9d69f7ecbf38e36056e502b94b0"></a>
dan_ackme 34:2616445d0823 139 <div class="memitem">
dan_ackme 34:2616445d0823 140 <div class="memproto">
dan_ackme 34:2616445d0823 141 <table class="memname">
dan_ackme 34:2616445d0823 142 <tr>
dan_ackme 34:2616445d0823 143 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::GhmInterface::ghmDeleteMessage </td>
dan_ackme 34:2616445d0823 144 <td>(</td>
dan_ackme 34:2616445d0823 145 <td class="paramtype">uint8_t&#160;</td>
dan_ackme 34:2616445d0823 146 <td class="paramname"><em>listIndex</em></td><td>)</td>
dan_ackme 34:2616445d0823 147 <td></td>
dan_ackme 34:2616445d0823 148 </tr>
dan_ackme 34:2616445d0823 149 </table>
dan_ackme 34:2616445d0823 150 </div><div class="memdoc">
dan_ackme 34:2616445d0823 151
dan_ackme 34:2616445d0823 152 <p>Delete message from <a href="http://goHACK.me">http://goHACK.me</a>. </p>
dan_ackme 34:2616445d0823 153 <dl class="section note"><dt>Note</dt><dd><a class="el" href="group__api__ghm__msg.html#gae69971594793e1a10f11a51277909502">ghmListMessages()</a> must be called first before using this method.</dd>
dan_ackme 34:2616445d0823 154 <dd>
dan_ackme 34:2616445d0823 155 The WiFi module must first be activated. See <a class="el" href="group__api__ghm__activate.html#gaa0213731eebd4a14e9099d01ff76beff">ghmActivate()</a></dd></dl>
dan_ackme 34:2616445d0823 156 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 34:2616445d0823 157 <table class="params">
dan_ackme 34:2616445d0823 158 <tr><td class="paramdir">[in]</td><td class="paramname">listIndex</td><td>The index of the message returned from <a class="el" href="group__api__ghm__msg.html#gae69971594793e1a10f11a51277909502" title="List available messages for device on http://goHACK.me. ">ghmListMessages()</a> </td></tr>
dan_ackme 34:2616445d0823 159 </table>
dan_ackme 34:2616445d0823 160 </dd>
dan_ackme 34:2616445d0823 161 </dl>
dan_ackme 34:2616445d0823 162 <dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
dan_ackme 34:2616445d0823 163
dan_ackme 34:2616445d0823 164 </div>
dan_ackme 34:2616445d0823 165 </div>
dan_ackme 34:2616445d0823 166 <a class="anchor" id="ga7273f4c691aeccd241327f1be3e8d0e9"></a>
dan_ackme 34:2616445d0823 167 <div class="memitem">
dan_ackme 34:2616445d0823 168 <div class="memproto">
dan_ackme 34:2616445d0823 169 <table class="memname">
dan_ackme 34:2616445d0823 170 <tr>
dan_ackme 34:2616445d0823 171 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::GhmInterface::ghmDeleteMessage </td>
dan_ackme 34:2616445d0823 172 <td>(</td>
dan_ackme 34:2616445d0823 173 <td class="paramtype">const char *&#160;</td>
dan_ackme 34:2616445d0823 174 <td class="paramname"><em>msgId</em></td><td>)</td>
dan_ackme 34:2616445d0823 175 <td></td>
dan_ackme 34:2616445d0823 176 </tr>
dan_ackme 34:2616445d0823 177 </table>
dan_ackme 34:2616445d0823 178 </div><div class="memdoc">
dan_ackme 34:2616445d0823 179
dan_ackme 34:2616445d0823 180 <p>Delete message from <a href="http://goHACK.me">http://goHACK.me</a>. </p>
dan_ackme 34:2616445d0823 181 <dl class="section note"><dt>Note</dt><dd>The WiFi module must first be activated. See <a class="el" href="group__api__ghm__activate.html#gaa0213731eebd4a14e9099d01ff76beff">ghmActivate()</a></dd></dl>
dan_ackme 34:2616445d0823 182 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 34:2616445d0823 183 <table class="params">
dan_ackme 34:2616445d0823 184 <tr><td class="paramdir">[in]</td><td class="paramname">msgId</td><td>The <a href="http://goHACK.me">http://goHACK.me</a> message ID. </td></tr>
dan_ackme 34:2616445d0823 185 </table>
dan_ackme 34:2616445d0823 186 </dd>
dan_ackme 34:2616445d0823 187 </dl>
dan_ackme 34:2616445d0823 188 <dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
dan_ackme 34:2616445d0823 189
dan_ackme 34:2616445d0823 190 </div>
dan_ackme 34:2616445d0823 191 </div>
dan_ackme 34:2616445d0823 192 <a class="anchor" id="gaaa05391432b2ca38bb416c671f57b234"></a>
dan_ackme 34:2616445d0823 193 <div class="memitem">
dan_ackme 34:2616445d0823 194 <div class="memproto">
dan_ackme 34:2616445d0823 195 <table class="memname">
dan_ackme 34:2616445d0823 196 <tr>
dan_ackme 34:2616445d0823 197 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::GhmInterface::ghmGetMessage </td>
dan_ackme 34:2616445d0823 198 <td>(</td>
dan_ackme 34:2616445d0823 199 <td class="paramtype"><a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;&#160;</td>
dan_ackme 34:2616445d0823 200 <td class="paramname"><em>socket</em>, </td>
dan_ackme 34:2616445d0823 201 </tr>
dan_ackme 34:2616445d0823 202 <tr>
dan_ackme 34:2616445d0823 203 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 204 <td></td>
dan_ackme 34:2616445d0823 205 <td class="paramtype"><a class="el" href="group__api__ghm__types.html#gaf75750bfef61c73f9e4677e9de663df1">GhmMessageGetType</a>&#160;</td>
dan_ackme 34:2616445d0823 206 <td class="paramname"><em>getType</em> = <code><a class="el" href="group__api__ghm__types.html#ggaf75750bfef61c73f9e4677e9de663df1a7b67ad45967438f44f6942968fb72127">GHM_MSG_GET_DATA_ONLY</a></code>&#160;</td>
dan_ackme 34:2616445d0823 207 </tr>
dan_ackme 34:2616445d0823 208 <tr>
dan_ackme 34:2616445d0823 209 <td></td>
dan_ackme 34:2616445d0823 210 <td>)</td>
dan_ackme 34:2616445d0823 211 <td></td><td></td>
dan_ackme 34:2616445d0823 212 </tr>
dan_ackme 34:2616445d0823 213 </table>
dan_ackme 34:2616445d0823 214 </div><div class="memdoc">
dan_ackme 34:2616445d0823 215
dan_ackme 34:2616445d0823 216 <p>GET message from <a href="http://goHACK.me">http://goHACK.me</a>. </p>
dan_ackme 34:2616445d0823 217 <dl class="section note"><dt>Note</dt><dd>The WiFi module must first be activated. See <a class="el" href="group__api__ghm__activate.html#gaa0213731eebd4a14e9099d01ff76beff">ghmActivate()</a></dd></dl>
dan_ackme 34:2616445d0823 218 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 34:2616445d0823 219 <table class="params">
dan_ackme 34:2616445d0823 220 <tr><td class="paramdir">[out]</td><td class="paramname">socket</td><td><a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> used to receive message data from <a href="http://goHACK.me">http://goHACK.me</a> </td></tr>
dan_ackme 34:2616445d0823 221 <tr><td class="paramdir">[in]</td><td class="paramname">getType</td><td>The additional message data to receive. See <a class="el" href="group__api__ghm__types.html#gaf75750bfef61c73f9e4677e9de663df1">GhmMessageGetType</a> </td></tr>
dan_ackme 34:2616445d0823 222 </table>
dan_ackme 34:2616445d0823 223 </dd>
dan_ackme 34:2616445d0823 224 </dl>
dan_ackme 34:2616445d0823 225 <dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
dan_ackme 34:2616445d0823 226
dan_ackme 34:2616445d0823 227 </div>
dan_ackme 34:2616445d0823 228 </div>
dan_ackme 34:2616445d0823 229 <a class="anchor" id="gaa905a010f0e234d290eaef6e42975c29"></a>
dan_ackme 34:2616445d0823 230 <div class="memitem">
dan_ackme 34:2616445d0823 231 <div class="memproto">
dan_ackme 34:2616445d0823 232 <table class="memname">
dan_ackme 34:2616445d0823 233 <tr>
dan_ackme 34:2616445d0823 234 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::GhmInterface::ghmGetMessage </td>
dan_ackme 34:2616445d0823 235 <td>(</td>
dan_ackme 34:2616445d0823 236 <td class="paramtype"><a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;&#160;</td>
dan_ackme 34:2616445d0823 237 <td class="paramname"><em>socket</em>, </td>
dan_ackme 34:2616445d0823 238 </tr>
dan_ackme 34:2616445d0823 239 <tr>
dan_ackme 34:2616445d0823 240 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 241 <td></td>
dan_ackme 34:2616445d0823 242 <td class="paramtype">uint8_t&#160;</td>
dan_ackme 34:2616445d0823 243 <td class="paramname"><em>listIndex</em>, </td>
dan_ackme 34:2616445d0823 244 </tr>
dan_ackme 34:2616445d0823 245 <tr>
dan_ackme 34:2616445d0823 246 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 247 <td></td>
dan_ackme 34:2616445d0823 248 <td class="paramtype"><a class="el" href="group__api__ghm__types.html#gaf75750bfef61c73f9e4677e9de663df1">GhmMessageGetType</a>&#160;</td>
dan_ackme 34:2616445d0823 249 <td class="paramname"><em>getType</em> = <code><a class="el" href="group__api__ghm__types.html#ggaf75750bfef61c73f9e4677e9de663df1a7b67ad45967438f44f6942968fb72127">GHM_MSG_GET_DATA_ONLY</a></code>&#160;</td>
dan_ackme 34:2616445d0823 250 </tr>
dan_ackme 34:2616445d0823 251 <tr>
dan_ackme 34:2616445d0823 252 <td></td>
dan_ackme 34:2616445d0823 253 <td>)</td>
dan_ackme 34:2616445d0823 254 <td></td><td></td>
dan_ackme 34:2616445d0823 255 </tr>
dan_ackme 34:2616445d0823 256 </table>
dan_ackme 34:2616445d0823 257 </div><div class="memdoc">
dan_ackme 34:2616445d0823 258
dan_ackme 34:2616445d0823 259 <p>GET message from <a href="http://goHACK.me">http://goHACK.me</a>. </p>
dan_ackme 34:2616445d0823 260 <dl class="section note"><dt>Note</dt><dd><a class="el" href="group__api__ghm__msg.html#gae69971594793e1a10f11a51277909502">ghmListMessages()</a> must be called first before using this method.</dd>
dan_ackme 34:2616445d0823 261 <dd>
dan_ackme 34:2616445d0823 262 The WiFi module must first be activated. See <a class="el" href="group__api__ghm__activate.html#gaa0213731eebd4a14e9099d01ff76beff">ghmActivate()</a></dd></dl>
dan_ackme 34:2616445d0823 263 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 34:2616445d0823 264 <table class="params">
dan_ackme 34:2616445d0823 265 <tr><td class="paramdir">[out]</td><td class="paramname">socket</td><td><a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> used to receive message data from <a href="http://goHACK.me">http://goHACK.me</a> </td></tr>
dan_ackme 34:2616445d0823 266 <tr><td class="paramdir">[in]</td><td class="paramname">listIndex</td><td>The index of the message returned from <a class="el" href="group__api__ghm__msg.html#gae69971594793e1a10f11a51277909502" title="List available messages for device on http://goHACK.me. ">ghmListMessages()</a> </td></tr>
dan_ackme 34:2616445d0823 267 <tr><td class="paramdir">[in]</td><td class="paramname">getType</td><td>The additional message data to receive. See <a class="el" href="group__api__ghm__types.html#gaf75750bfef61c73f9e4677e9de663df1">GhmMessageGetType</a> </td></tr>
dan_ackme 34:2616445d0823 268 </table>
dan_ackme 34:2616445d0823 269 </dd>
dan_ackme 34:2616445d0823 270 </dl>
dan_ackme 34:2616445d0823 271 <dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
dan_ackme 34:2616445d0823 272
dan_ackme 34:2616445d0823 273 </div>
dan_ackme 34:2616445d0823 274 </div>
dan_ackme 34:2616445d0823 275 <a class="anchor" id="ga9c6dffaa871f2443a32d75276160682d"></a>
dan_ackme 34:2616445d0823 276 <div class="memitem">
dan_ackme 34:2616445d0823 277 <div class="memproto">
dan_ackme 34:2616445d0823 278 <table class="memname">
dan_ackme 34:2616445d0823 279 <tr>
dan_ackme 34:2616445d0823 280 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::GhmInterface::ghmGetMessage </td>
dan_ackme 34:2616445d0823 281 <td>(</td>
dan_ackme 34:2616445d0823 282 <td class="paramtype"><a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;&#160;</td>
dan_ackme 34:2616445d0823 283 <td class="paramname"><em>socket</em>, </td>
dan_ackme 34:2616445d0823 284 </tr>
dan_ackme 34:2616445d0823 285 <tr>
dan_ackme 34:2616445d0823 286 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 287 <td></td>
dan_ackme 34:2616445d0823 288 <td class="paramtype">const char *&#160;</td>
dan_ackme 34:2616445d0823 289 <td class="paramname"><em>msgId</em>, </td>
dan_ackme 34:2616445d0823 290 </tr>
dan_ackme 34:2616445d0823 291 <tr>
dan_ackme 34:2616445d0823 292 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 293 <td></td>
dan_ackme 34:2616445d0823 294 <td class="paramtype"><a class="el" href="group__api__ghm__types.html#gaf75750bfef61c73f9e4677e9de663df1">GhmMessageGetType</a>&#160;</td>
dan_ackme 34:2616445d0823 295 <td class="paramname"><em>getType</em> = <code><a class="el" href="group__api__ghm__types.html#ggaf75750bfef61c73f9e4677e9de663df1a7b67ad45967438f44f6942968fb72127">GHM_MSG_GET_DATA_ONLY</a></code>&#160;</td>
dan_ackme 34:2616445d0823 296 </tr>
dan_ackme 34:2616445d0823 297 <tr>
dan_ackme 34:2616445d0823 298 <td></td>
dan_ackme 34:2616445d0823 299 <td>)</td>
dan_ackme 34:2616445d0823 300 <td></td><td></td>
dan_ackme 34:2616445d0823 301 </tr>
dan_ackme 34:2616445d0823 302 </table>
dan_ackme 34:2616445d0823 303 </div><div class="memdoc">
dan_ackme 34:2616445d0823 304
dan_ackme 34:2616445d0823 305 <p>GET message from <a href="http://goHACK.me">http://goHACK.me</a>. </p>
dan_ackme 34:2616445d0823 306 <dl class="section note"><dt>Note</dt><dd>The WiFi module must first be activated. See <a class="el" href="group__api__ghm__activate.html#gaa0213731eebd4a14e9099d01ff76beff">ghmActivate()</a></dd></dl>
dan_ackme 34:2616445d0823 307 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 34:2616445d0823 308 <table class="params">
dan_ackme 34:2616445d0823 309 <tr><td class="paramdir">[out]</td><td class="paramname">socket</td><td><a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> used to receive message data from <a href="http://goHACK.me">http://goHACK.me</a> </td></tr>
dan_ackme 34:2616445d0823 310 <tr><td class="paramdir">[in]</td><td class="paramname">msgId</td><td>The <a href="http://goHACK.me">http://goHACK.me</a> message ID. </td></tr>
dan_ackme 34:2616445d0823 311 <tr><td class="paramdir">[in]</td><td class="paramname">getType</td><td>The additional message data to receive. See <a class="el" href="group__api__ghm__types.html#gaf75750bfef61c73f9e4677e9de663df1">GhmMessageGetType</a> </td></tr>
dan_ackme 34:2616445d0823 312 </table>
dan_ackme 34:2616445d0823 313 </dd>
dan_ackme 34:2616445d0823 314 </dl>
dan_ackme 34:2616445d0823 315 <dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
dan_ackme 34:2616445d0823 316
dan_ackme 34:2616445d0823 317 </div>
dan_ackme 34:2616445d0823 318 </div>
dan_ackme 34:2616445d0823 319 <a class="anchor" id="gae69971594793e1a10f11a51277909502"></a>
dan_ackme 34:2616445d0823 320 <div class="memitem">
dan_ackme 34:2616445d0823 321 <div class="memproto">
dan_ackme 34:2616445d0823 322 <table class="memname">
dan_ackme 34:2616445d0823 323 <tr>
dan_ackme 34:2616445d0823 324 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::GhmInterface::ghmListMessages </td>
dan_ackme 34:2616445d0823 325 <td>(</td>
dan_ackme 34:2616445d0823 326 <td class="paramtype"><a class="el" href="classwiconnect_1_1_ghm_message_list.html">GhmMessageList</a> &amp;&#160;</td>
dan_ackme 34:2616445d0823 327 <td class="paramname"><em>msgList</em>, </td>
dan_ackme 34:2616445d0823 328 </tr>
dan_ackme 34:2616445d0823 329 <tr>
dan_ackme 34:2616445d0823 330 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 331 <td></td>
dan_ackme 34:2616445d0823 332 <td class="paramtype">uint8_t&#160;</td>
dan_ackme 34:2616445d0823 333 <td class="paramname"><em>maxCount</em> = <code>0</code>&#160;</td>
dan_ackme 34:2616445d0823 334 </tr>
dan_ackme 34:2616445d0823 335 <tr>
dan_ackme 34:2616445d0823 336 <td></td>
dan_ackme 34:2616445d0823 337 <td>)</td>
dan_ackme 34:2616445d0823 338 <td></td><td></td>
dan_ackme 34:2616445d0823 339 </tr>
dan_ackme 34:2616445d0823 340 </table>
dan_ackme 34:2616445d0823 341 </div><div class="memdoc">
dan_ackme 34:2616445d0823 342
dan_ackme 34:2616445d0823 343 <p>List available messages for device on <a href="http://goHACK.me">http://goHACK.me</a>. </p>
dan_ackme 34:2616445d0823 344 <dl class="section note"><dt>Note</dt><dd>The WiFi module must first be activated. See <a class="el" href="group__api__ghm__activate.html#gaa0213731eebd4a14e9099d01ff76beff">ghmActivate()</a></dd></dl>
dan_ackme 34:2616445d0823 345 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 34:2616445d0823 346 <table class="params">
dan_ackme 34:2616445d0823 347 <tr><td class="paramdir">[out]</td><td class="paramname">msgList</td><td><a class="el" href="classwiconnect_1_1_ghm_message_list.html">GhmMessageList</a> to hold received messages. </td></tr>
dan_ackme 34:2616445d0823 348 <tr><td class="paramdir">[in]</td><td class="paramname">maxCount</td><td>Optional, the maximum number of messages to receive. If 0, receive all messages (max of 25). </td></tr>
dan_ackme 34:2616445d0823 349 </table>
dan_ackme 34:2616445d0823 350 </dd>
dan_ackme 34:2616445d0823 351 </dl>
dan_ackme 34:2616445d0823 352 <dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
dan_ackme 34:2616445d0823 353
dan_ackme 34:2616445d0823 354 </div>
dan_ackme 34:2616445d0823 355 </div>
dan_ackme 34:2616445d0823 356 <a class="anchor" id="gadc281f497041b26a151c72a0b5d03543"></a>
dan_ackme 34:2616445d0823 357 <div class="memitem">
dan_ackme 34:2616445d0823 358 <div class="memproto">
dan_ackme 34:2616445d0823 359 <table class="memname">
dan_ackme 34:2616445d0823 360 <tr>
dan_ackme 34:2616445d0823 361 <td class="memname"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> wiconnect::GhmInterface::ghmPostMessage </td>
dan_ackme 34:2616445d0823 362 <td>(</td>
dan_ackme 34:2616445d0823 363 <td class="paramtype"><a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> &amp;&#160;</td>
dan_ackme 34:2616445d0823 364 <td class="paramname"><em>socket</em>, </td>
dan_ackme 34:2616445d0823 365 </tr>
dan_ackme 34:2616445d0823 366 <tr>
dan_ackme 34:2616445d0823 367 <td class="paramkey"></td>
dan_ackme 34:2616445d0823 368 <td></td>
dan_ackme 34:2616445d0823 369 <td class="paramtype">bool&#160;</td>
dan_ackme 34:2616445d0823 370 <td class="paramname"><em>jsonFormatted</em> = <code>false</code>&#160;</td>
dan_ackme 34:2616445d0823 371 </tr>
dan_ackme 34:2616445d0823 372 <tr>
dan_ackme 34:2616445d0823 373 <td></td>
dan_ackme 34:2616445d0823 374 <td>)</td>
dan_ackme 34:2616445d0823 375 <td></td><td></td>
dan_ackme 34:2616445d0823 376 </tr>
dan_ackme 34:2616445d0823 377 </table>
dan_ackme 34:2616445d0823 378 </div><div class="memdoc">
dan_ackme 34:2616445d0823 379
dan_ackme 34:2616445d0823 380 <p>POST message to <a href="http://goHACK.me">http://goHACK.me</a>. </p>
dan_ackme 34:2616445d0823 381 <dl class="section note"><dt>Note</dt><dd>The WiFi module must first be activated. See <a class="el" href="group__api__ghm__activate.html#gaa0213731eebd4a14e9099d01ff76beff">ghmActivate()</a></dd></dl>
dan_ackme 34:2616445d0823 382 <dl class="params"><dt>Parameters</dt><dd>
dan_ackme 34:2616445d0823 383 <table class="params">
dan_ackme 34:2616445d0823 384 <tr><td class="paramdir">[out]</td><td class="paramname">socket</td><td><a class="el" href="classwiconnect_1_1_wiconnect_socket.html">WiconnectSocket</a> used to send message data to <a href="http://goHACK.me">http://goHACK.me</a> </td></tr>
dan_ackme 34:2616445d0823 385 <tr><td class="paramdir">[in]</td><td class="paramname">jsonFormatted</td><td>If true, the input message data should be JSON formatted, else the message data should be ASCII formatted. </td></tr>
dan_ackme 34:2616445d0823 386 </table>
dan_ackme 34:2616445d0823 387 </dd>
dan_ackme 34:2616445d0823 388 </dl>
dan_ackme 34:2616445d0823 389 <dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl>
dan_ackme 34:2616445d0823 390
dan_ackme 34:2616445d0823 391 </div>
dan_ackme 34:2616445d0823 392 </div>
dan_ackme 34:2616445d0823 393 </div><!-- contents -->
dan_ackme 34:2616445d0823 394 </div><!-- doc-content -->
dan_ackme 34:2616445d0823 395 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 34:2616445d0823 396 <ul>
dan_ackme 34:2616445d0823 397 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 34:2616445d0823 398 </ul>
dan_ackme 34:2616445d0823 399 </div>
dan_ackme 34:2616445d0823 400 </body>
dan_ackme 34:2616445d0823 401 </html>