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/group__api__core__types.html@21:17bb3eddcbae, 2014-08-26 (annotated)

Committer:
dan_ackme
Date:
Tue Aug 26 16:38:19 2014 -0700
Revision:
21:17bb3eddcbae
Parent:
17:7268f365676b
Child:
26:8067e3d463d3
Add TCP server API

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 14:85a2ed029f37 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
dan_ackme 14:85a2ed029f37 2 <html xmlns="http://www.w3.org/1999/xhtml">
dan_ackme 14:85a2ed029f37 3 <head>
dan_ackme 14:85a2ed029f37 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
dan_ackme 14:85a2ed029f37 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
dan_ackme 14:85a2ed029f37 6 <title>ACKme WiConnect Host Library</title>
dan_ackme 14:85a2ed029f37 7 <link rel="icon" href="favicon.ico" type="image/x-icon">
dan_ackme 14:85a2ed029f37 8 <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
dan_ackme 14:85a2ed029f37 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 14:85a2ed029f37 10 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 14:85a2ed029f37 11 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 14:85a2ed029f37 12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 14:85a2ed029f37 13 <script type="text/javascript" src="resize.js"></script>
dan_ackme 14:85a2ed029f37 14 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 14:85a2ed029f37 15 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 16 $(document).ready(initResizable);
dan_ackme 14:85a2ed029f37 17 $(window).load(resizeHeight);
dan_ackme 14:85a2ed029f37 18 </script>
dan_ackme 14:85a2ed029f37 19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 14:85a2ed029f37 20 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 14:85a2ed029f37 21 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 22 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 14:85a2ed029f37 23 </script>
dan_ackme 14:85a2ed029f37 24 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 14:85a2ed029f37 25 </head>
dan_ackme 14:85a2ed029f37 26 <body>
dan_ackme 14:85a2ed029f37 27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 14:85a2ed029f37 28 <div id="titlearea" style="font-family:verdana;">
dan_ackme 14:85a2ed029f37 29 <table border='0' cellpadding='0' cellspacing='0' width="98%">
dan_ackme 14:85a2ed029f37 30 <tr style="height:20px"><td>&nbsp;</td></tr>
dan_ackme 14:85a2ed029f37 31 <tr style="border-collapse: collapse; padding: 0;">
dan_ackme 14:85a2ed029f37 32 <td style="width:20px"></td>
dan_ackme 14:85a2ed029f37 33 <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
dan_ackme 14:85a2ed029f37 34 <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
dan_ackme 14:85a2ed029f37 35 WiConnect Host Library- API Reference Guide</td>
dan_ackme 14:85a2ed029f37 36 <td style="width:20px"></td>
dan_ackme 14:85a2ed029f37 37 </tr>
dan_ackme 14:85a2ed029f37 38 <tr><td>&nbsp;</td></tr>
dan_ackme 14:85a2ed029f37 39 </table>
dan_ackme 14:85a2ed029f37 40 </div><!-- Generated by Doxygen 1.8.7 -->
dan_ackme 14:85a2ed029f37 41 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 42 var searchBox = new SearchBox("searchBox", "search",false,'Search');
dan_ackme 14:85a2ed029f37 43 </script>
dan_ackme 14:85a2ed029f37 44 <div id="navrow1" class="tabs">
dan_ackme 14:85a2ed029f37 45 <ul class="tablist">
dan_ackme 14:85a2ed029f37 46 <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
dan_ackme 14:85a2ed029f37 47 <li><a href="modules.html"><span>Library&#160;API</span></a></li>
dan_ackme 14:85a2ed029f37 48 <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
dan_ackme 14:85a2ed029f37 49 <li><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 14:85a2ed029f37 50 <li><a href="http://wiconnect.ack.me/1.2/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
dan_ackme 14:85a2ed029f37 51 <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
dan_ackme 14:85a2ed029f37 52 <li>
dan_ackme 14:85a2ed029f37 53 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 14:85a2ed029f37 54 <span class="left">
dan_ackme 14:85a2ed029f37 55 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 14:85a2ed029f37 56 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 14:85a2ed029f37 57 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 14:85a2ed029f37 58 alt=""/>
dan_ackme 14:85a2ed029f37 59 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 14:85a2ed029f37 60 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 14:85a2ed029f37 61 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 14:85a2ed029f37 62 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 14:85a2ed029f37 63 </span><span class="right">
dan_ackme 14:85a2ed029f37 64 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 14:85a2ed029f37 65 </span>
dan_ackme 14:85a2ed029f37 66 </div>
dan_ackme 14:85a2ed029f37 67 </li>
dan_ackme 14:85a2ed029f37 68 </ul>
dan_ackme 14:85a2ed029f37 69 </div>
dan_ackme 14:85a2ed029f37 70 </div><!-- top -->
dan_ackme 14:85a2ed029f37 71 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 14:85a2ed029f37 72 <div id="nav-tree">
dan_ackme 14:85a2ed029f37 73 <div id="nav-tree-contents">
dan_ackme 14:85a2ed029f37 74 <div id="nav-sync" class="sync"></div>
dan_ackme 14:85a2ed029f37 75 </div>
dan_ackme 14:85a2ed029f37 76 </div>
dan_ackme 14:85a2ed029f37 77 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 14:85a2ed029f37 78 class="ui-resizable-handle">
dan_ackme 14:85a2ed029f37 79 </div>
dan_ackme 14:85a2ed029f37 80 </div>
dan_ackme 14:85a2ed029f37 81 <script type="text/javascript">
dan_ackme 14:85a2ed029f37 82 $(document).ready(function(){initNavTree('group__api__core__types.html','');});
dan_ackme 14:85a2ed029f37 83 </script>
dan_ackme 14:85a2ed029f37 84 <div id="doc-content">
dan_ackme 14:85a2ed029f37 85 <!-- window showing the filter options -->
dan_ackme 14:85a2ed029f37 86 <div id="MSearchSelectWindow"
dan_ackme 14:85a2ed029f37 87 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 14:85a2ed029f37 88 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 14:85a2ed029f37 89 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 14:85a2ed029f37 90 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>
dan_ackme 14:85a2ed029f37 91
dan_ackme 14:85a2ed029f37 92 <!-- iframe showing the search results (closed by default) -->
dan_ackme 14:85a2ed029f37 93 <div id="MSearchResultsWindow">
dan_ackme 14:85a2ed029f37 94 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 14:85a2ed029f37 95 name="MSearchResults" id="MSearchResults">
dan_ackme 14:85a2ed029f37 96 </iframe>
dan_ackme 14:85a2ed029f37 97 </div>
dan_ackme 14:85a2ed029f37 98
dan_ackme 14:85a2ed029f37 99 <div class="header">
dan_ackme 14:85a2ed029f37 100 <div class="summary">
dan_ackme 14:85a2ed029f37 101 <a href="#nested-classes">Classes</a> &#124;
dan_ackme 14:85a2ed029f37 102 <a href="#typedef-members">Typedefs</a> &#124;
dan_ackme 14:85a2ed029f37 103 <a href="#enum-members">Enumerations</a> </div>
dan_ackme 14:85a2ed029f37 104 <div class="headertitle">
dan_ackme 14:85a2ed029f37 105 <div class="title">Types<div class="ingroups"><a class="el" href="group__api__core.html">Core</a></div></div> </div>
dan_ackme 14:85a2ed029f37 106 </div><!--header-->
dan_ackme 14:85a2ed029f37 107 <div class="contents">
dan_ackme 14:85a2ed029f37 108
dan_ackme 14:85a2ed029f37 109 <p>Core Types.
dan_ackme 14:85a2ed029f37 110 <a href="#details">More...</a></p>
dan_ackme 14:85a2ed029f37 111 <table class="memberdecls">
dan_ackme 14:85a2ed029f37 112 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
dan_ackme 14:85a2ed029f37 113 Classes</h2></td></tr>
dan_ackme 14:85a2ed029f37 114 <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 14:85a2ed029f37 115 <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 14:85a2ed029f37 116 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 14:85a2ed029f37 117 <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 14:85a2ed029f37 118 <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 14:85a2ed029f37 119 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 14:85a2ed029f37 120 <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 14:85a2ed029f37 121 <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 14:85a2ed029f37 122 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 14:85a2ed029f37 123 <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 14:85a2ed029f37 124 <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 14:85a2ed029f37 125 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 14:85a2ed029f37 126 <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 14:85a2ed029f37 127 <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 14:85a2ed029f37 128 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 14:85a2ed029f37 129 <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 14:85a2ed029f37 130 <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 14:85a2ed029f37 131 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 14:85a2ed029f37 132 </table><table class="memberdecls">
dan_ackme 14:85a2ed029f37 133 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
dan_ackme 14:85a2ed029f37 134 Typedefs</h2></td></tr>
dan_ackme 14:85a2ed029f37 135 <tr class="memitem:ga1cf4dfa71da0b0dc3dc707dacf56cc9c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1cf4dfa71da0b0dc3dc707dacf56cc9c"></a>
dan_ackme 14:85a2ed029f37 136 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 14:85a2ed029f37 137 <tr class="memdesc:ga1cf4dfa71da0b0dc3dc707dacf56cc9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pin name on HOST. <br /></td></tr>
dan_ackme 14:85a2ed029f37 138 <tr class="separator:ga1cf4dfa71da0b0dc3dc707dacf56cc9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 14:85a2ed029f37 139 </table><table class="memberdecls">
dan_ackme 14:85a2ed029f37 140 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
dan_ackme 14:85a2ed029f37 141 Enumerations</h2></td></tr>
dan_ackme 14:85a2ed029f37 142 <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 14:85a2ed029f37 143 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ad345e256266694df078c99eaee04f789">wiconnect::WICONNECT_ABORTED</a> = 3,
dan_ackme 14:85a2ed029f37 144 <br />
dan_ackme 14:85a2ed029f37 145 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a5bff05280d726da505c6e6ec2f085bd1">wiconnect::WICONNECT_IDLE</a> = 2,
dan_ackme 14:85a2ed029f37 146 <br />
dan_ackme 14:85a2ed029f37 147 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a289d83a8cf2d1e1f272134d8268925c0">wiconnect::WICONNECT_PROCESSING</a> = 1,
dan_ackme 14:85a2ed029f37 148 <br />
dan_ackme 14:85a2ed029f37 149 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7">wiconnect::WICONNECT_SUCCESS</a> = 0,
dan_ackme 14:85a2ed029f37 150 <br />
dan_ackme 14:85a2ed029f37 151 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05acfd6d3c1efd03fae8cd443bc01bca8d6">wiconnect::WICONNECT_ERROR</a> = -1,
dan_ackme 14:85a2ed029f37 152 <br />
dan_ackme 14:85a2ed029f37 153 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a511a4e6fa8470f52110fc64f04cfe5ff">wiconnect::WICONNECT_CMD_RESPONSE_ERROR</a> = -2,
dan_ackme 14:85a2ed029f37 154 <br />
dan_ackme 14:85a2ed029f37 155 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a25c48e037bc3615840b81461db6385b5">wiconnect::WICONNECT_NULL_BUFFER</a> = -3,
dan_ackme 14:85a2ed029f37 156 <br />
dan_ackme 14:85a2ed029f37 157 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05afea61b8f5d17f6be2aee2ce5b6bb7c43">wiconnect::WICONNECT_NOT_INITIALIZED</a> = -4,
dan_ackme 14:85a2ed029f37 158 <br />
dan_ackme 14:85a2ed029f37 159 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a2b2577cc3efe2cb37fda7dead222878f">wiconnect::WICONNECT_OVERFLOW</a> = -5,
dan_ackme 14:85a2ed029f37 160 <br />
dan_ackme 14:85a2ed029f37 161 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ae6a9fb0c6333a0431e5775da996087ac">wiconnect::WICONNECT_TIMEOUT</a> = -6,
dan_ackme 14:85a2ed029f37 162 <br />
dan_ackme 14:85a2ed029f37 163 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ab17f003b5f90e88328bbc76435f9f2e5">wiconnect::WICONNECT_RESPONSE_PARSE_ERROR</a> = -8,
dan_ackme 14:85a2ed029f37 164 <br />
dan_ackme 14:85a2ed029f37 165 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a376da897f3a629fd71abd9db9f4cea83">wiconnect::WICONNECT_ANOTHER_CMD_EXECUTING</a> = -9,
dan_ackme 14:85a2ed029f37 166 <br />
dan_ackme 14:85a2ed029f37 167 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ae96c2edcdade2809cdb60a8a5b0983fa">wiconnect::WICONNECT_BAD_ARG</a> = -10,
dan_ackme 14:85a2ed029f37 168 <br />
dan_ackme 14:85a2ed029f37 169 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ab18f839c77a6a1f964c096980ef24adc">wiconnect::WICONNECT_UNSUPPORTED</a> = -11,
dan_ackme 14:85a2ed029f37 170 <br />
dan_ackme 14:85a2ed029f37 171 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ab16dea725fe7b09d91a7651f18174cff">wiconnect::WICONNECT_PINNAME_TO_GPIO_MAPPER_NULL</a> = -12,
dan_ackme 14:85a2ed029f37 172 <br />
dan_ackme 14:85a2ed029f37 173 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a5d9162280a5269a34245bf53c87401a4">wiconnect::WICONNECT_DUPLICATE</a> = -13,
dan_ackme 14:85a2ed029f37 174 <br />
dan_ackme 14:85a2ed029f37 175 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ab9123e9628c3156f34c44913a72b4195">wiconnect::WICONNECT_NOT_FOUND</a> = -14,
dan_ackme 14:85a2ed029f37 176 <br />
dan_ackme 14:85a2ed029f37 177 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a8d6d7c580a7aa3c4d64d41cac6e0307a">wiconnect::WICONNECT_PINNAME_TO_GPIO_NO_MAPPING</a> = -15,
dan_ackme 14:85a2ed029f37 178 <br />
dan_ackme 14:85a2ed029f37 179 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05aecb3384d1dc5a61345346a8cd63527b2">wiconnect::WICONNECT_NOT_CONNECTED</a> = -16,
dan_ackme 14:85a2ed029f37 180 <br />
dan_ackme 14:85a2ed029f37 181 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a7d4f9bd8b2b8ccc2ad902271e5241b02">wiconnect::WICONNECT_UNDERFLOW</a> = -17,
dan_ackme 14:85a2ed029f37 182 <br />
dan_ackme 14:85a2ed029f37 183 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05a28240905349a60a6b52bddbbd152ea5e">wiconnect::WICONNECT_MONITOR_NOT_AVAILABLE</a> = -18,
dan_ackme 14:85a2ed029f37 184 <br />
dan_ackme 14:85a2ed029f37 185 &#160;&#160;<a class="el" href="group__api__core__types.html#gga325637ed501728bd6c8c7a7982b9ce05ab3f9c2611514967ca4f155e35f522cc2">wiconnect::WICONNECT_NOT_OPENED_FOR_READING</a> = -19
dan_ackme 14:85a2ed029f37 186 <br />
dan_ackme 14:85a2ed029f37 187 }</td></tr>
dan_ackme 14:85a2ed029f37 188 <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 14:85a2ed029f37 189 <tr class="separator:ga325637ed501728bd6c8c7a7982b9ce05"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 14:85a2ed029f37 190 </table>
dan_ackme 14:85a2ed029f37 191 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 14:85a2ed029f37 192 <p>Core Types. </p>
dan_ackme 14:85a2ed029f37 193 <h2 class="groupheader">Enumeration Type Documentation</h2>
dan_ackme 14:85a2ed029f37 194 <a class="anchor" id="ga325637ed501728bd6c8c7a7982b9ce05"></a>
dan_ackme 14:85a2ed029f37 195 <div class="memitem">
dan_ackme 14:85a2ed029f37 196 <div class="memproto">
dan_ackme 14:85a2ed029f37 197 <table class="memname">
dan_ackme 14:85a2ed029f37 198 <tr>
dan_ackme 14:85a2ed029f37 199 <td class="memname">enum <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">wiconnect::WiconnectResult</a></td>
dan_ackme 14:85a2ed029f37 200 </tr>
dan_ackme 14:85a2ed029f37 201 </table>
dan_ackme 14:85a2ed029f37 202 </div><div class="memdoc">
dan_ackme 14:85a2ed029f37 203
dan_ackme 14:85a2ed029f37 204 <p>API Result code. </p>
dan_ackme 14:85a2ed029f37 205 <table class="fieldtable">
dan_ackme 14:85a2ed029f37 206 <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 14:85a2ed029f37 207 <p>Command was aborted. </p>
dan_ackme 14:85a2ed029f37 208 </td></tr>
dan_ackme 14:85a2ed029f37 209 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a5bff05280d726da505c6e6ec2f085bd1"></a>WICONNECT_IDLE&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 210 <p>Library not processing any commands. </p>
dan_ackme 14:85a2ed029f37 211 </td></tr>
dan_ackme 14:85a2ed029f37 212 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a289d83a8cf2d1e1f272134d8268925c0"></a>WICONNECT_PROCESSING&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 213 <p>Library processing current command. </p>
dan_ackme 14:85a2ed029f37 214 </td></tr>
dan_ackme 14:85a2ed029f37 215 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05af0a2ad8af174aee6b52813d8528328e7"></a>WICONNECT_SUCCESS&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 216 <p>Command successfully completed. </p>
dan_ackme 14:85a2ed029f37 217 </td></tr>
dan_ackme 14:85a2ed029f37 218 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05acfd6d3c1efd03fae8cd443bc01bca8d6"></a>WICONNECT_ERROR&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 219 <p>Generic error. </p>
dan_ackme 14:85a2ed029f37 220 </td></tr>
dan_ackme 14:85a2ed029f37 221 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a511a4e6fa8470f52110fc64f04cfe5ff"></a>WICONNECT_CMD_RESPONSE_ERROR&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 222 <p>Module returned error code. </p>
dan_ackme 14:85a2ed029f37 223 </td></tr>
dan_ackme 14:85a2ed029f37 224 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a25c48e037bc3615840b81461db6385b5"></a>WICONNECT_NULL_BUFFER&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 225 <p>Null buffer supplied. </p>
dan_ackme 14:85a2ed029f37 226 </td></tr>
dan_ackme 14:85a2ed029f37 227 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05afea61b8f5d17f6be2aee2ce5b6bb7c43"></a>WICONNECT_NOT_INITIALIZED&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 228 <p>Library not initialed. </p>
dan_ackme 14:85a2ed029f37 229 </td></tr>
dan_ackme 14:85a2ed029f37 230 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a2b2577cc3efe2cb37fda7dead222878f"></a>WICONNECT_OVERFLOW&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 231 <p>Buffer overflowed. </p>
dan_ackme 14:85a2ed029f37 232 </td></tr>
dan_ackme 14:85a2ed029f37 233 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ae6a9fb0c6333a0431e5775da996087ac"></a>WICONNECT_TIMEOUT&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 234 <p>Command timed out. </p>
dan_ackme 14:85a2ed029f37 235 </td></tr>
dan_ackme 14:85a2ed029f37 236 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ab17f003b5f90e88328bbc76435f9f2e5"></a>WICONNECT_RESPONSE_PARSE_ERROR&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 237 <p>Failed to parse module response. </p>
dan_ackme 14:85a2ed029f37 238 </td></tr>
dan_ackme 14:85a2ed029f37 239 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a376da897f3a629fd71abd9db9f4cea83"></a>WICONNECT_ANOTHER_CMD_EXECUTING&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 240 <p>Currently executing another command. </p>
dan_ackme 14:85a2ed029f37 241 </td></tr>
dan_ackme 14:85a2ed029f37 242 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ae96c2edcdade2809cdb60a8a5b0983fa"></a>WICONNECT_BAD_ARG&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 243 <p>Bad argument supplied. </p>
dan_ackme 14:85a2ed029f37 244 </td></tr>
dan_ackme 14:85a2ed029f37 245 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ab18f839c77a6a1f964c096980ef24adc"></a>WICONNECT_UNSUPPORTED&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 246 <p>Command / parameter not supported. </p>
dan_ackme 14:85a2ed029f37 247 </td></tr>
dan_ackme 14:85a2ed029f37 248 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ab16dea725fe7b09d91a7651f18174cff"></a>WICONNECT_PINNAME_TO_GPIO_MAPPER_NULL&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 249 <p>The pinToGpioMapper hasn't been set. </p>
dan_ackme 14:85a2ed029f37 250 </td></tr>
dan_ackme 14:85a2ed029f37 251 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a5d9162280a5269a34245bf53c87401a4"></a>WICONNECT_DUPLICATE&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 252 <p>Duplicate value. </p>
dan_ackme 14:85a2ed029f37 253 </td></tr>
dan_ackme 14:85a2ed029f37 254 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ab9123e9628c3156f34c44913a72b4195"></a>WICONNECT_NOT_FOUND&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 255 <p>Not found. </p>
dan_ackme 14:85a2ed029f37 256 </td></tr>
dan_ackme 14:85a2ed029f37 257 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a8d6d7c580a7aa3c4d64d41cac6e0307a"></a>WICONNECT_PINNAME_TO_GPIO_NO_MAPPING&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 258 <p>No mapping found for given pin. </p>
dan_ackme 14:85a2ed029f37 259 </td></tr>
dan_ackme 14:85a2ed029f37 260 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05aecb3384d1dc5a61345346a8cd63527b2"></a>WICONNECT_NOT_CONNECTED&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 261 <p>Not connected. </p>
dan_ackme 14:85a2ed029f37 262 </td></tr>
dan_ackme 14:85a2ed029f37 263 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a7d4f9bd8b2b8ccc2ad902271e5241b02"></a>WICONNECT_UNDERFLOW&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 264 <p>Data underflow. </p>
dan_ackme 14:85a2ed029f37 265 </td></tr>
dan_ackme 14:85a2ed029f37 266 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05a28240905349a60a6b52bddbbd152ea5e"></a>WICONNECT_MONITOR_NOT_AVAILABLE&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 267 <p>Background processing monitor is not available (i.e in use) </p>
dan_ackme 14:85a2ed029f37 268 </td></tr>
dan_ackme 14:85a2ed029f37 269 <tr><td class="fieldname"><a class="anchor" id="gga325637ed501728bd6c8c7a7982b9ce05ab3f9c2611514967ca4f155e35f522cc2"></a>WICONNECT_NOT_OPENED_FOR_READING&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 270 <p>The file is not open for reading. </p>
dan_ackme 14:85a2ed029f37 271 </td></tr>
dan_ackme 14:85a2ed029f37 272 </table>
dan_ackme 21:17bb3eddcbae 273 <dl><dt><b>Examples: </b></dt><dd><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 14:85a2ed029f37 274 </dl>
dan_ackme 21:17bb3eddcbae 275 <p>Definition at line <a class="el" href="_wiconnect_types_8h_source.html#l00155">155</a> of file <a class="el" href="_wiconnect_types_8h_source.html">WiconnectTypes.h</a>.</p>
dan_ackme 14:85a2ed029f37 276
dan_ackme 14:85a2ed029f37 277 </div>
dan_ackme 14:85a2ed029f37 278 </div>
dan_ackme 14:85a2ed029f37 279 </div><!-- contents -->
dan_ackme 14:85a2ed029f37 280 </div><!-- doc-content -->
dan_ackme 14:85a2ed029f37 281 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 14:85a2ed029f37 282 <ul>
dan_ackme 14:85a2ed029f37 283 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 14:85a2ed029f37 284 </ul>
dan_ackme 14:85a2ed029f37 285 </div>
dan_ackme 14:85a2ed029f37 286 </body>
dan_ackme 14:85a2ed029f37 287 </html>