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__core__types.html@39:a963f69cb2de, 2015-02-23 (annotated)

Committer:
dan_ackme
Date:
Mon Feb 23 20:30:18 2015 -0800
Revision:
39:a963f69cb2de
Parent:
34:2616445d0823 
added httpAcceptWebsocket API

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__core__types.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="#nested-classes">Classes</a> &#124;
dan_ackme 34:2616445d0823 103 <a href="#typedef-members">Typedefs</a> &#124;
dan_ackme 34:2616445d0823 104 <a href="#enum-members">Enumerations</a> </div>
dan_ackme 34:2616445d0823 105 <div class="headertitle">
dan_ackme 34:2616445d0823 106 <div class="title">Types<div class="ingroups"><a class="el" href="group__api__core.html">Core</a></div></div> </div>
dan_ackme 34:2616445d0823 107 </div><!--header-->
dan_ackme 34:2616445d0823 108 <div class="contents">
dan_ackme 34:2616445d0823 109
dan_ackme 34:2616445d0823 110 <p>Core Types.
dan_ackme 34:2616445d0823 111 <a href="#details">More...</a></p>
dan_ackme 34:2616445d0823 112 <table class="memberdecls">
dan_ackme 34:2616445d0823 113 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
dan_ackme 34:2616445d0823 114 Classes</h2></td></tr>
dan_ackme 34:2616445d0823 115 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a></td></tr>
dan_ackme 34:2616445d0823 116 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The root WiConnect library class. This class inheriets all WiConnect functionality. <a href="classwiconnect_1_1_wiconnect.html#details">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 117 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 118 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_callback.html">wiconnect::Callback</a></td></tr>
dan_ackme 34:2616445d0823 119 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generic callback function. <a href="classwiconnect_1_1_callback.html#details">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 120 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 121 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_log_func.html">wiconnect::LogFunc</a></td></tr>
dan_ackme 34:2616445d0823 122 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Logging callback function. <a href="classwiconnect_1_1_log_func.html#details">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 123 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 124 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_queued_command.html">wiconnect::QueuedCommand</a></td></tr>
dan_ackme 34:2616445d0823 125 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class which contains command for asynchronous processing. <a href="classwiconnect_1_1_queued_command.html#details">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 126 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 127 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_reader_func.html">wiconnect::ReaderFunc</a></td></tr>
dan_ackme 34:2616445d0823 128 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generic data reading callback function. <a href="classwiconnect_1_1_reader_func.html#details">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 129 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 130 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classwiconnect_1_1_serial_config.html">wiconnect::SerialConfig</a></td></tr>
dan_ackme 34:2616445d0823 131 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Host&lt;-&gt;<a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> Module serial configuration. <a href="classwiconnect_1_1_serial_config.html#details">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 132 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 133 </table><table class="memberdecls">
dan_ackme 34:2616445d0823 134 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
dan_ackme 34:2616445d0823 135 Typedefs</h2></td></tr>
dan_ackme 34:2616445d0823 136 <tr class="memitem:ga1cf4dfa71da0b0dc3dc707dacf56cc9c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1cf4dfa71da0b0dc3dc707dacf56cc9c"></a>
dan_ackme 34:2616445d0823 137 typedef PinName&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__types.html#ga1cf4dfa71da0b0dc3dc707dacf56cc9c">wiconnect::Pin</a></td></tr>
dan_ackme 34:2616445d0823 138 <tr class="memdesc:ga1cf4dfa71da0b0dc3dc707dacf56cc9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pin name on HOST. <br /></td></tr>
dan_ackme 34:2616445d0823 139 <tr class="separator:ga1cf4dfa71da0b0dc3dc707dacf56cc9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 140 </table><table class="memberdecls">
dan_ackme 34:2616445d0823 141 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
dan_ackme 34:2616445d0823 142 Enumerations</h2></td></tr>
dan_ackme 34:2616445d0823 143 <tr class="memitem:ga325637ed501728bd6c8c7a7982b9ce05"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">wiconnect::WiconnectResult</a> { <br />
dan_ackme 34:2616445d0823 144 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ad345e256266694df078c99eaee04f789">wiconnect::WICONNECT_ABORTED</a> = 3,
dan_ackme 34:2616445d0823 145 <br />
dan_ackme 34:2616445d0823 146 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a5bff05280d726da505c6e6ec2f085bd1">wiconnect::WICONNECT_IDLE</a> = 2,
dan_ackme 34:2616445d0823 147 <br />
dan_ackme 34:2616445d0823 148 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a289d83a8cf2d1e1f272134d8268925c0">wiconnect::WICONNECT_PROCESSING</a> = 1,
dan_ackme 34:2616445d0823 149 <br />
dan_ackme 34:2616445d0823 150 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7">wiconnect::WICONNECT_SUCCESS</a> = 0,
dan_ackme 34:2616445d0823 151 <br />
dan_ackme 34:2616445d0823 152 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05acfd6d3c1efd03fae8cd443bc01bca8d6">wiconnect::WICONNECT_ERROR</a> = -1,
dan_ackme 34:2616445d0823 153 <br />
dan_ackme 34:2616445d0823 154 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a511a4e6fa8470f52110fc64f04cfe5ff">wiconnect::WICONNECT_CMD_RESPONSE_ERROR</a> = -2,
dan_ackme 34:2616445d0823 155 <br />
dan_ackme 34:2616445d0823 156 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a25c48e037bc3615840b81461db6385b5">wiconnect::WICONNECT_NULL_BUFFER</a> = -3,
dan_ackme 34:2616445d0823 157 <br />
dan_ackme 34:2616445d0823 158 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05afea61b8f5d17f6be2aee2ce5b6bb7c43">wiconnect::WICONNECT_NOT_INITIALIZED</a> = -4,
dan_ackme 34:2616445d0823 159 <br />
dan_ackme 34:2616445d0823 160 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a2b2577cc3efe2cb37fda7dead222878f">wiconnect::WICONNECT_OVERFLOW</a> = -5,
dan_ackme 34:2616445d0823 161 <br />
dan_ackme 34:2616445d0823 162 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ae6a9fb0c6333a0431e5775da996087ac">wiconnect::WICONNECT_TIMEOUT</a> = -6,
dan_ackme 34:2616445d0823 163 <br />
dan_ackme 34:2616445d0823 164 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ab17f003b5f90e88328bbc76435f9f2e5">wiconnect::WICONNECT_RESPONSE_PARSE_ERROR</a> = -8,
dan_ackme 34:2616445d0823 165 <br />
dan_ackme 34:2616445d0823 166 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a376da897f3a629fd71abd9db9f4cea83">wiconnect::WICONNECT_ANOTHER_CMD_EXECUTING</a> = -9,
dan_ackme 34:2616445d0823 167 <br />
dan_ackme 34:2616445d0823 168 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ae96c2edcdade2809cdb60a8a5b0983fa">wiconnect::WICONNECT_BAD_ARG</a> = -10,
dan_ackme 34:2616445d0823 169 <br />
dan_ackme 34:2616445d0823 170 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ab18f839c77a6a1f964c096980ef24adc">wiconnect::WICONNECT_UNSUPPORTED</a> = -11,
dan_ackme 34:2616445d0823 171 <br />
dan_ackme 34:2616445d0823 172 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ab16dea725fe7b09d91a7651f18174cff">wiconnect::WICONNECT_PINNAME_TO_GPIO_MAPPER_NULL</a> = -12,
dan_ackme 34:2616445d0823 173 <br />
dan_ackme 34:2616445d0823 174 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a5d9162280a5269a34245bf53c87401a4">wiconnect::WICONNECT_DUPLICATE</a> = -13,
dan_ackme 34:2616445d0823 175 <br />
dan_ackme 34:2616445d0823 176 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ab9123e9628c3156f34c44913a72b4195">wiconnect::WICONNECT_NOT_FOUND</a> = -14,
dan_ackme 34:2616445d0823 177 <br />
dan_ackme 34:2616445d0823 178 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a8d6d7c580a7aa3c4d64d41cac6e0307a">wiconnect::WICONNECT_PINNAME_TO_GPIO_NO_MAPPING</a> = -15,
dan_ackme 34:2616445d0823 179 <br />
dan_ackme 34:2616445d0823 180 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05aecb3384d1dc5a61345346a8cd63527b2">wiconnect::WICONNECT_NOT_CONNECTED</a> = -16,
dan_ackme 34:2616445d0823 181 <br />
dan_ackme 34:2616445d0823 182 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a7d4f9bd8b2b8ccc2ad902271e5241b02">wiconnect::WICONNECT_UNDERFLOW</a> = -17,
dan_ackme 34:2616445d0823 183 <br />
dan_ackme 34:2616445d0823 184 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a28240905349a60a6b52bddbbd152ea5e">wiconnect::WICONNECT_MONITOR_NOT_AVAILABLE</a> = -18,
dan_ackme 34:2616445d0823 185 <br />
dan_ackme 34:2616445d0823 186 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ab3f9c2611514967ca4f155e35f522cc2">wiconnect::WICONNECT_NOT_OPENED_FOR_READING</a> = -19,
dan_ackme 34:2616445d0823 187 <br />
dan_ackme 34:2616445d0823 188 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a62defbdafd472461054dd6bb888c9a1e">wiconnect::WICONNECT_FIRMWARE_OUTDATED</a> = -20
dan_ackme 34:2616445d0823 189 <br />
dan_ackme 34:2616445d0823 190 }</td></tr>
dan_ackme 34:2616445d0823 191 <tr class="memdesc:ga325637ed501728bd6c8c7a7982b9ce05"><td class="mdescLeft">&#160;</td><td class="mdescRight">API Result code. <a href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">More...</a><br /></td></tr>
dan_ackme 34:2616445d0823 192 <tr class="separator:ga325637ed501728bd6c8c7a7982b9ce05"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 34:2616445d0823 193 </table>
dan_ackme 34:2616445d0823 194 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 34:2616445d0823 195 <p>Core Types. </p>
dan_ackme 34:2616445d0823 196 <h2 class="groupheader">Enumeration Type Documentation</h2>
dan_ackme 34:2616445d0823 197 <a class="anchor" id="ga325637ed501728bd6c8c7a7982b9ce05"></a>
dan_ackme 34:2616445d0823 198 <div class="memitem">
dan_ackme 34:2616445d0823 199 <div class="memproto">
dan_ackme 34:2616445d0823 200 <table class="memname">
dan_ackme 34:2616445d0823 201 <tr>
dan_ackme 34:2616445d0823 202 <td class="memname">enum <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">wiconnect::WiconnectResult</a></td>
dan_ackme 34:2616445d0823 203 </tr>
dan_ackme 34:2616445d0823 204 </table>
dan_ackme 34:2616445d0823 205 </div><div class="memdoc">
dan_ackme 34:2616445d0823 206
dan_ackme 34:2616445d0823 207 <p>API Result code. </p>
dan_ackme 34:2616445d0823 208 <table class="fieldtable">
dan_ackme 34:2616445d0823 209 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ad345e256266694df078c99eaee04f789"></a>WICONNECT_ABORTED&#160;</td><td class="fielddoc">
dan_ackme 34:2616445d0823 210 <p>Command was aborted. </p>
dan_ackme 34:2616445d0823 211 </td></tr>
dan_ackme 34:2616445d0823 212 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a5bff05280d726da505c6e6ec2f085bd1"></a>WICONNECT_IDLE&#160;</td><td class="fielddoc">
dan_ackme 34:2616445d0823 213 <p>Library not processing any commands. </p>
dan_ackme 34:2616445d0823 214 </td></tr>
dan_ackme 34:2616445d0823 215 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a289d83a8cf2d1e1f272134d8268925c0"></a>WICONNECT_PROCESSING&#160;</td><td class="fielddoc">
dan_ackme 34:2616445d0823 216 <p>Library processing current command. </p>
dan_ackme 34:2616445d0823 217 </td></tr>
dan_ackme 34:2616445d0823 218 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7"></a>WICONNECT_SUCCESS&#160;</td><td class="fielddoc">
dan_ackme 34:2616445d0823 219 <p>Command successfully completed. </p>
dan_ackme 34:2616445d0823 220 </td></tr>
dan_ackme 34:2616445d0823 221 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05acfd6d3c1efd03fae8cd443bc01bca8d6"></a>WICONNECT_ERROR&#160;</td><td class="fielddoc">
dan_ackme 34:2616445d0823 222 <p>Generic error. </p>
dan_ackme 34:2616445d0823 223 </td></tr>
dan_ackme 34:2616445d0823 224 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a511a4e6fa8470f52110fc64f04cfe5ff"></a>WICONNECT_CMD_RESPONSE_ERROR&#160;</td><td class="fielddoc">
dan_ackme 34:2616445d0823 225 <p>Module returned error code. </p>
dan_ackme 34:2616445d0823 226 </td></tr>
dan_ackme 34:2616445d0823 227 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a25c48e037bc3615840b81461db6385b5"></a>WICONNECT_NULL_BUFFER&#160;</td><td class="fielddoc">
dan_ackme 34:2616445d0823 228 <p>Null buffer supplied. </p>
dan_ackme 34:2616445d0823 229 </td></tr>
dan_ackme 34:2616445d0823 230 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05afea61b8f5d17f6be2aee2ce5b6bb7c43"></a>WICONNECT_NOT_INITIALIZED&#160;</td><td class="fielddoc">
dan_ackme 34:2616445d0823 231 <p>Library not initialed. </p>
dan_ackme 34:2616445d0823 232 </td></tr>
dan_ackme 34:2616445d0823 233 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a2b2577cc3efe2cb37fda7dead222878f"></a>WICONNECT_OVERFLOW&#160;</td><td class="fielddoc">
dan_ackme 34:2616445d0823 234 <p>Buffer overflowed. </p>
dan_ackme 34:2616445d0823 235 </td></tr>
dan_ackme 34:2616445d0823 236 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ae6a9fb0c6333a0431e5775da996087ac"></a>WICONNECT_TIMEOUT&#160;</td><td class="fielddoc">
dan_ackme 34:2616445d0823 237 <p>Command timed out. </p>
dan_ackme 34:2616445d0823 238 </td></tr>
dan_ackme 34:2616445d0823 239 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ab17f003b5f90e88328bbc76435f9f2e5"></a>WICONNECT_RESPONSE_PARSE_ERROR&#160;</td><td class="fielddoc">
dan_ackme 34:2616445d0823 240 <p>Failed to parse module response. </p>
dan_ackme 34:2616445d0823 241 </td></tr>
dan_ackme 34:2616445d0823 242 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a376da897f3a629fd71abd9db9f4cea83"></a>WICONNECT_ANOTHER_CMD_EXECUTING&#160;</td><td class="fielddoc">
dan_ackme 34:2616445d0823 243 <p>Currently executing another command. </p>
dan_ackme 34:2616445d0823 244 </td></tr>
dan_ackme 34:2616445d0823 245 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ae96c2edcdade2809cdb60a8a5b0983fa"></a>WICONNECT_BAD_ARG&#160;</td><td class="fielddoc">
dan_ackme 34:2616445d0823 246 <p>Bad argument supplied. </p>
dan_ackme 34:2616445d0823 247 </td></tr>
dan_ackme 34:2616445d0823 248 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ab18f839c77a6a1f964c096980ef24adc"></a>WICONNECT_UNSUPPORTED&#160;</td><td class="fielddoc">
dan_ackme 34:2616445d0823 249 <p>Command / parameter not supported. </p>
dan_ackme 34:2616445d0823 250 </td></tr>
dan_ackme 34:2616445d0823 251 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ab16dea725fe7b09d91a7651f18174cff"></a>WICONNECT_PINNAME_TO_GPIO_MAPPER_NULL&#160;</td><td class="fielddoc">
dan_ackme 34:2616445d0823 252 <p>The pinToGpioMapper hasn't been set. </p>
dan_ackme 34:2616445d0823 253 </td></tr>
dan_ackme 34:2616445d0823 254 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a5d9162280a5269a34245bf53c87401a4"></a>WICONNECT_DUPLICATE&#160;</td><td class="fielddoc">
dan_ackme 34:2616445d0823 255 <p>Duplicate value. </p>
dan_ackme 34:2616445d0823 256 </td></tr>
dan_ackme 34:2616445d0823 257 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ab9123e9628c3156f34c44913a72b4195"></a>WICONNECT_NOT_FOUND&#160;</td><td class="fielddoc">
dan_ackme 34:2616445d0823 258 <p>Not found. </p>
dan_ackme 34:2616445d0823 259 </td></tr>
dan_ackme 34:2616445d0823 260 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a8d6d7c580a7aa3c4d64d41cac6e0307a"></a>WICONNECT_PINNAME_TO_GPIO_NO_MAPPING&#160;</td><td class="fielddoc">
dan_ackme 34:2616445d0823 261 <p>No mapping found for given pin. </p>
dan_ackme 34:2616445d0823 262 </td></tr>
dan_ackme 34:2616445d0823 263 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05aecb3384d1dc5a61345346a8cd63527b2"></a>WICONNECT_NOT_CONNECTED&#160;</td><td class="fielddoc">
dan_ackme 34:2616445d0823 264 <p>Not connected. </p>
dan_ackme 34:2616445d0823 265 </td></tr>
dan_ackme 34:2616445d0823 266 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a7d4f9bd8b2b8ccc2ad902271e5241b02"></a>WICONNECT_UNDERFLOW&#160;</td><td class="fielddoc">
dan_ackme 34:2616445d0823 267 <p>Data underflow. </p>
dan_ackme 34:2616445d0823 268 </td></tr>
dan_ackme 34:2616445d0823 269 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a28240905349a60a6b52bddbbd152ea5e"></a>WICONNECT_MONITOR_NOT_AVAILABLE&#160;</td><td class="fielddoc">
dan_ackme 34:2616445d0823 270 <p>Background processing monitor is not available (i.e in use) </p>
dan_ackme 34:2616445d0823 271 </td></tr>
dan_ackme 34:2616445d0823 272 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ab3f9c2611514967ca4f155e35f522cc2"></a>WICONNECT_NOT_OPENED_FOR_READING&#160;</td><td class="fielddoc">
dan_ackme 34:2616445d0823 273 <p>The file is not open for reading. </p>
dan_ackme 34:2616445d0823 274 </td></tr>
dan_ackme 34:2616445d0823 275 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a62defbdafd472461054dd6bb888c9a1e"></a>WICONNECT_FIRMWARE_OUTDATED&#160;</td><td class="fielddoc">
dan_ackme 34:2616445d0823 276 <p>The WiFi module's firmware is out-dated. See updateFirmware() to update the firmware. </p>
dan_ackme 34:2616445d0823 277 </td></tr>
dan_ackme 34:2616445d0823 278 </table>
dan_ackme 39:a963f69cb2de 279 <dl><dt><b>Examples: </b></dt><dd><a class="el" href="http_get_2example_8cpp-example.html#a0">http_get/example.cpp</a>, <a class="el" href="join_2example_8cpp-example.html#a0">join/example.cpp</a>, <a class="el" href="ota_2example_8cpp-example.html#a0">ota/example.cpp</a>, <a class="el" href="tcp_server_2example_8cpp-example.html#a0">tcp_server/example.cpp</a>, and <a class="el" href="web_setup_2example_8cpp-example.html#a0">web_setup/example.cpp</a>.</dd>
dan_ackme 34:2616445d0823 280 </dl>
dan_ackme 34:2616445d0823 281 <p>Definition at line <a class="el" href="_wiconnect_types_8h_source.html#l00166">166</a> of file <a class="el" href="_wiconnect_types_8h_source.html">WiconnectTypes.h</a>.</p>
dan_ackme 34:2616445d0823 282
dan_ackme 34:2616445d0823 283 </div>
dan_ackme 34:2616445d0823 284 </div>
dan_ackme 34:2616445d0823 285 </div><!-- contents -->
dan_ackme 34:2616445d0823 286 </div><!-- doc-content -->
dan_ackme 34:2616445d0823 287 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 34:2616445d0823 288 <ul>
dan_ackme 34:2616445d0823 289 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 34:2616445d0823 290 </ul>
dan_ackme 34:2616445d0823 291 </div>
dan_ackme 34:2616445d0823 292 </body>
dan_ackme 34:2616445d0823 293 </html>