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__network__types.html@29:b6af04b77a56, 2014-10-27 (annotated)

Committer:
dan_ackme
Date:
Mon Oct 27 13:42:26 2014 -0700
Revision:
29:b6af04b77a56
Parent:
26:8067e3d463d3 
refactored library layout

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 26:8067e3d463d3 50 <li><a href="http://wiconnect.ack.me/2.0/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__network__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__network.html">Network</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>Network 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_network_interface.html">wiconnect::NetworkInterface</a></td></tr>
dan_ackme 14:85a2ed029f37 115 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The provides an interface for joining and/or creating a network. It provides other utilities such as scanning for networks, pinging a network, resolving a domain name to IP address. <a href="classwiconnect_1_1_network_interface.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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwiconnect_1_1_ssid.html">wiconnect::Ssid</a></td></tr>
dan_ackme 14:85a2ed029f37 118 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Network SSID type. <a href="structwiconnect_1_1_ssid.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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwiconnect_1_1_mac_address.html">wiconnect::MacAddress</a></td></tr>
dan_ackme 14:85a2ed029f37 121 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Network MAC Address type. <a href="structwiconnect_1_1_mac_address.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_scan_result.html">wiconnect::ScanResult</a></td></tr>
dan_ackme 14:85a2ed029f37 124 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains single entry from WiFi scan results. <a href="classwiconnect_1_1_scan_result.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_scan_result_list.html">wiconnect::ScanResultList</a></td></tr>
dan_ackme 14:85a2ed029f37 127 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">List of WiFi network scan results. <a href="classwiconnect_1_1_scan_result_list.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 </table><table class="memberdecls">
dan_ackme 14:85a2ed029f37 130 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
dan_ackme 14:85a2ed029f37 131 Typedefs</h2></td></tr>
dan_ackme 14:85a2ed029f37 132 <tr class="memitem:ga04b095d2e2f32a3fd23e346a4be969d8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga04b095d2e2f32a3fd23e346a4be969d8"></a>
dan_ackme 14:85a2ed029f37 133 typedef char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__types.html#ga04b095d2e2f32a3fd23e346a4be969d8">wiconnect::MacAddressStrBuffer</a> [18]</td></tr>
dan_ackme 14:85a2ed029f37 134 <tr class="memdesc:ga04b095d2e2f32a3fd23e346a4be969d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Buffer to hold a MAC address string. <br /></td></tr>
dan_ackme 14:85a2ed029f37 135 <tr class="separator:ga04b095d2e2f32a3fd23e346a4be969d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 14:85a2ed029f37 136 <tr class="memitem:ga38e0a82235258f96340b9ce2c6e1426c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga38e0a82235258f96340b9ce2c6e1426c"></a>
dan_ackme 14:85a2ed029f37 137 typedef char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__types.html#ga38e0a82235258f96340b9ce2c6e1426c">wiconnect::SsidStrBuffer</a> [129]</td></tr>
dan_ackme 14:85a2ed029f37 138 <tr class="memdesc:ga38e0a82235258f96340b9ce2c6e1426c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Buffer to hold a SSID string. <br /></td></tr>
dan_ackme 14:85a2ed029f37 139 <tr class="separator:ga38e0a82235258f96340b9ce2c6e1426c"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 14:85a2ed029f37 140 <tr class="memitem:gaa68646bb07ee9f174097b60ac7327342"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa68646bb07ee9f174097b60ac7327342"></a>
dan_ackme 14:85a2ed029f37 141 typedef char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__types.html#gaa68646bb07ee9f174097b60ac7327342">wiconnect::IpStrBuffer</a> [18]</td></tr>
dan_ackme 14:85a2ed029f37 142 <tr class="memdesc:gaa68646bb07ee9f174097b60ac7327342"><td class="mdescLeft">&#160;</td><td class="mdescRight">Buffer to hold an IP address string. <br /></td></tr>
dan_ackme 14:85a2ed029f37 143 <tr class="separator:gaa68646bb07ee9f174097b60ac7327342"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 14:85a2ed029f37 144 </table><table class="memberdecls">
dan_ackme 14:85a2ed029f37 145 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
dan_ackme 14:85a2ed029f37 146 Enumerations</h2></td></tr>
dan_ackme 14:85a2ed029f37 147 <tr class="memitem:gab448e57fc1a5e21cbba0283fd1a35d99"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">wiconnect::NetworkStatus</a> { <br />
dan_ackme 14:85a2ed029f37 148 &#160;&#160;<a class="el" href="group__api__network__types.html#ggab448e57fc1a5e21cbba0283fd1a35d99a6a4dd5a93528f27eb983bf856b9f5067">wiconnect::NETWORK_STATUS_DOWN</a>,
dan_ackme 14:85a2ed029f37 149 <br />
dan_ackme 14:85a2ed029f37 150 &#160;&#160;<a class="el" href="group__api__network__types.html#ggab448e57fc1a5e21cbba0283fd1a35d99a8e40c9f169976770c3e65b9c0e44874c">wiconnect::NETWORK_STATUS_WIFI_ONLY</a>,
dan_ackme 14:85a2ed029f37 151 <br />
dan_ackme 14:85a2ed029f37 152 &#160;&#160;<a class="el" href="group__api__network__types.html#ggab448e57fc1a5e21cbba0283fd1a35d99a6d6f2fd76cab833e55bc398541c52b46">wiconnect::NETWORK_STATUS_UP</a>,
dan_ackme 14:85a2ed029f37 153 <br />
dan_ackme 14:85a2ed029f37 154 &#160;&#160;<a class="el" href="group__api__network__types.html#ggab448e57fc1a5e21cbba0283fd1a35d99a2916360f96699b2bf42cf5e122562497">wiconnect::NETWORK_STATUS_JOINING</a>
dan_ackme 14:85a2ed029f37 155 <br />
dan_ackme 14:85a2ed029f37 156 }</td></tr>
dan_ackme 14:85a2ed029f37 157 <tr class="memdesc:gab448e57fc1a5e21cbba0283fd1a35d99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Network connection status. <a href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">More...</a><br /></td></tr>
dan_ackme 14:85a2ed029f37 158 <tr class="separator:gab448e57fc1a5e21cbba0283fd1a35d99"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 26:8067e3d463d3 159 <tr class="memitem:ga5f6f5c916a5dd1676f98da7fa511451d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">wiconnect::NetworkJoinResult</a> { <br />
dan_ackme 26:8067e3d463d3 160 &#160;&#160;<a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451da2ac6866940725552e31532002ef649a5">wiconnect::NETWORK_JOIN_RESULT_NONE</a>,
dan_ackme 26:8067e3d463d3 161 <br />
dan_ackme 26:8067e3d463d3 162 &#160;&#160;<a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451dabfbb179ad94f8d5a57a9da86de9c65a8">wiconnect::NETWORK_JOIN_RESULT_SUCCESS</a>,
dan_ackme 26:8067e3d463d3 163 <br />
dan_ackme 26:8067e3d463d3 164 &#160;&#160;<a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451da60569216928bd30142e2e143eaf58475">wiconnect::NETWORK_JOIN_RESULT_JOINING</a>,
dan_ackme 26:8067e3d463d3 165 <br />
dan_ackme 26:8067e3d463d3 166 &#160;&#160;<a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451daea6aa0a779a2823eadafa82dda6b7304">wiconnect::NETWORK_JOIN_RESULT_NO_SSID</a>,
dan_ackme 26:8067e3d463d3 167 <br />
dan_ackme 26:8067e3d463d3 168 &#160;&#160;<a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451da02f32115d4a39e6028e5ebb4944f0bec">wiconnect::NETWORK_JOIN_RESULT_NO_PASSWORD</a>,
dan_ackme 26:8067e3d463d3 169 <br />
dan_ackme 26:8067e3d463d3 170 &#160;&#160;<a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451dabb8da6425a24810668eade3488113957">wiconnect::NETWORK_JOIN_RESULT_BAD_SECURITY</a>,
dan_ackme 26:8067e3d463d3 171 <br />
dan_ackme 26:8067e3d463d3 172 &#160;&#160;<a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451da5c790fb0440c39d95ec785e1c31c3cb2">wiconnect::NETWORK_JOIN_RESULT_NOT_FOUND</a>,
dan_ackme 26:8067e3d463d3 173 <br />
dan_ackme 26:8067e3d463d3 174 &#160;&#160;<a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451da76b3ad647f00a3dc52e71e4ed670e7dc">wiconnect::NETWORK_JOIN_RESULT_FAILED</a>,
dan_ackme 26:8067e3d463d3 175 <br />
dan_ackme 26:8067e3d463d3 176 &#160;&#160;<a class="el" href="group__api__network__types.html#gga5f6f5c916a5dd1676f98da7fa511451daed880c261bae590a5f59aebb01b6912c">wiconnect::NETWORK_JOIN_RESULT_ABORTED</a>
dan_ackme 26:8067e3d463d3 177 <br />
dan_ackme 26:8067e3d463d3 178 }</td></tr>
dan_ackme 26:8067e3d463d3 179 <tr class="memdesc:ga5f6f5c916a5dd1676f98da7fa511451d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Network connection status. <a href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">More...</a><br /></td></tr>
dan_ackme 26:8067e3d463d3 180 <tr class="separator:ga5f6f5c916a5dd1676f98da7fa511451d"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 14:85a2ed029f37 181 <tr class="memitem:gac5aead2b4cca0122a60168e75ea41d36"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">wiconnect::NetworkSignalStrength</a> { <br />
dan_ackme 14:85a2ed029f37 182 &#160;&#160;<a class="el" href="group__api__network__types.html#ggac5aead2b4cca0122a60168e75ea41d36a2911018510263b4d6db772cf6ea69385">wiconnect::NETWORK_RSSI_EXCELLENT</a> = 0,
dan_ackme 14:85a2ed029f37 183 <br />
dan_ackme 14:85a2ed029f37 184 &#160;&#160;<a class="el" href="group__api__network__types.html#ggac5aead2b4cca0122a60168e75ea41d36ad77f98cf80b81d4c5277672402c0b713">wiconnect::NETWORK_RSSI_VERY_GOOD</a> = 1,
dan_ackme 14:85a2ed029f37 185 <br />
dan_ackme 14:85a2ed029f37 186 &#160;&#160;<a class="el" href="group__api__network__types.html#ggac5aead2b4cca0122a60168e75ea41d36a5aa38a03f1ec4cdcdd1f0c41dfd19533">wiconnect::NETWORK_RSSI_GOOD</a> = 2,
dan_ackme 14:85a2ed029f37 187 <br />
dan_ackme 14:85a2ed029f37 188 &#160;&#160;<a class="el" href="group__api__network__types.html#ggac5aead2b4cca0122a60168e75ea41d36a2728fe7e544bee45b00ef95117085eae">wiconnect::NETWORK_RSSI_POOR</a> = 3,
dan_ackme 14:85a2ed029f37 189 <br />
dan_ackme 14:85a2ed029f37 190 &#160;&#160;<a class="el" href="group__api__network__types.html#ggac5aead2b4cca0122a60168e75ea41d36ab0e9cbbf4e2c6dee74d2639caef2cffa">wiconnect::NETWORK_RSSI_VERY_POOR</a> = 4,
dan_ackme 14:85a2ed029f37 191 <br />
dan_ackme 14:85a2ed029f37 192 &#160;&#160;<a class="el" href="group__api__network__types.html#ggac5aead2b4cca0122a60168e75ea41d36a095c1eef3bdeb16e33b1f6a976e9f6c4">wiconnect::NETWORK_RSSI_UNKNOWN</a> = 5
dan_ackme 14:85a2ed029f37 193 <br />
dan_ackme 14:85a2ed029f37 194 }</td></tr>
dan_ackme 14:85a2ed029f37 195 <tr class="memdesc:gac5aead2b4cca0122a60168e75ea41d36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Network RSSI signal level. <a href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">More...</a><br /></td></tr>
dan_ackme 14:85a2ed029f37 196 <tr class="separator:gac5aead2b4cca0122a60168e75ea41d36"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 14:85a2ed029f37 197 <tr class="memitem:ga026bd11cd5df47b7022362243e2d553f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga026bd11cd5df47b7022362243e2d553f"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__types.html#ga026bd11cd5df47b7022362243e2d553f">wiconnect::NetworkSecurity</a> </td></tr>
dan_ackme 14:85a2ed029f37 198 <tr class="memdesc:ga026bd11cd5df47b7022362243e2d553f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Network security type. <br /></td></tr>
dan_ackme 14:85a2ed029f37 199 <tr class="separator:ga026bd11cd5df47b7022362243e2d553f"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 14:85a2ed029f37 200 </table>
dan_ackme 14:85a2ed029f37 201 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 14:85a2ed029f37 202 <p>Network Types. </p>
dan_ackme 14:85a2ed029f37 203 <h2 class="groupheader">Enumeration Type Documentation</h2>
dan_ackme 26:8067e3d463d3 204 <a class="anchor" id="ga5f6f5c916a5dd1676f98da7fa511451d"></a>
dan_ackme 26:8067e3d463d3 205 <div class="memitem">
dan_ackme 26:8067e3d463d3 206 <div class="memproto">
dan_ackme 26:8067e3d463d3 207 <table class="memname">
dan_ackme 26:8067e3d463d3 208 <tr>
dan_ackme 26:8067e3d463d3 209 <td class="memname">enum <a class="el" href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">wiconnect::NetworkJoinResult</a></td>
dan_ackme 26:8067e3d463d3 210 </tr>
dan_ackme 26:8067e3d463d3 211 </table>
dan_ackme 26:8067e3d463d3 212 </div><div class="memdoc">
dan_ackme 26:8067e3d463d3 213
dan_ackme 26:8067e3d463d3 214 <p>Network connection status. </p>
dan_ackme 26:8067e3d463d3 215 <table class="fieldtable">
dan_ackme 26:8067e3d463d3 216 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga5f6f5c916a5dd1676f98da7fa511451da2ac6866940725552e31532002ef649a5"></a>NETWORK_JOIN_RESULT_NONE&#160;</td><td class="fielddoc">
dan_ackme 26:8067e3d463d3 217 <p>Haven't attempted to join. </p>
dan_ackme 26:8067e3d463d3 218 </td></tr>
dan_ackme 26:8067e3d463d3 219 <tr><td class="fieldname"><a class="anchor" id="gga5f6f5c916a5dd1676f98da7fa511451dabfbb179ad94f8d5a57a9da86de9c65a8"></a>NETWORK_JOIN_RESULT_SUCCESS&#160;</td><td class="fielddoc">
dan_ackme 26:8067e3d463d3 220 <p>Successfully joined the network. </p>
dan_ackme 26:8067e3d463d3 221 </td></tr>
dan_ackme 26:8067e3d463d3 222 <tr><td class="fieldname"><a class="anchor" id="gga5f6f5c916a5dd1676f98da7fa511451da60569216928bd30142e2e143eaf58475"></a>NETWORK_JOIN_RESULT_JOINING&#160;</td><td class="fielddoc">
dan_ackme 26:8067e3d463d3 223 <p>Currently attempting to join. </p>
dan_ackme 26:8067e3d463d3 224 </td></tr>
dan_ackme 26:8067e3d463d3 225 <tr><td class="fieldname"><a class="anchor" id="gga5f6f5c916a5dd1676f98da7fa511451daea6aa0a779a2823eadafa82dda6b7304"></a>NETWORK_JOIN_RESULT_NO_SSID&#160;</td><td class="fielddoc">
dan_ackme 26:8067e3d463d3 226 <p>The SSID has not be configured. </p>
dan_ackme 26:8067e3d463d3 227 </td></tr>
dan_ackme 26:8067e3d463d3 228 <tr><td class="fieldname"><a class="anchor" id="gga5f6f5c916a5dd1676f98da7fa511451da02f32115d4a39e6028e5ebb4944f0bec"></a>NETWORK_JOIN_RESULT_NO_PASSWORD&#160;</td><td class="fielddoc">
dan_ackme 26:8067e3d463d3 229 <p>The network requires a password and none has been set. </p>
dan_ackme 26:8067e3d463d3 230 </td></tr>
dan_ackme 26:8067e3d463d3 231 <tr><td class="fieldname"><a class="anchor" id="gga5f6f5c916a5dd1676f98da7fa511451dabb8da6425a24810668eade3488113957"></a>NETWORK_JOIN_RESULT_BAD_SECURITY&#160;</td><td class="fielddoc">
dan_ackme 26:8067e3d463d3 232 <p>The specified security type is not supported by the network. </p>
dan_ackme 26:8067e3d463d3 233 </td></tr>
dan_ackme 26:8067e3d463d3 234 <tr><td class="fieldname"><a class="anchor" id="gga5f6f5c916a5dd1676f98da7fa511451da5c790fb0440c39d95ec785e1c31c3cb2"></a>NETWORK_JOIN_RESULT_NOT_FOUND&#160;</td><td class="fielddoc">
dan_ackme 26:8067e3d463d3 235 <p>The network with the configured SSID was not found. </p>
dan_ackme 26:8067e3d463d3 236 </td></tr>
dan_ackme 26:8067e3d463d3 237 <tr><td class="fieldname"><a class="anchor" id="gga5f6f5c916a5dd1676f98da7fa511451da76b3ad647f00a3dc52e71e4ed670e7dc"></a>NETWORK_JOIN_RESULT_FAILED&#160;</td><td class="fielddoc">
dan_ackme 26:8067e3d463d3 238 <p>Failed to join the network. </p>
dan_ackme 26:8067e3d463d3 239 </td></tr>
dan_ackme 26:8067e3d463d3 240 <tr><td class="fieldname"><a class="anchor" id="gga5f6f5c916a5dd1676f98da7fa511451daed880c261bae590a5f59aebb01b6912c"></a>NETWORK_JOIN_RESULT_ABORTED&#160;</td><td class="fielddoc">
dan_ackme 26:8067e3d463d3 241 <p>Joining was aborted (via command) </p>
dan_ackme 26:8067e3d463d3 242 </td></tr>
dan_ackme 26:8067e3d463d3 243 </table>
dan_ackme 26:8067e3d463d3 244
dan_ackme 29:b6af04b77a56 245 <p>Definition at line <a class="el" href="_wiconnect_types_8h_source.html#l00250">250</a> of file <a class="el" href="_wiconnect_types_8h_source.html">WiconnectTypes.h</a>.</p>
dan_ackme 26:8067e3d463d3 246
dan_ackme 26:8067e3d463d3 247 </div>
dan_ackme 26:8067e3d463d3 248 </div>
dan_ackme 14:85a2ed029f37 249 <a class="anchor" id="gac5aead2b4cca0122a60168e75ea41d36"></a>
dan_ackme 14:85a2ed029f37 250 <div class="memitem">
dan_ackme 14:85a2ed029f37 251 <div class="memproto">
dan_ackme 14:85a2ed029f37 252 <table class="memname">
dan_ackme 14:85a2ed029f37 253 <tr>
dan_ackme 14:85a2ed029f37 254 <td class="memname">enum <a class="el" href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">wiconnect::NetworkSignalStrength</a></td>
dan_ackme 14:85a2ed029f37 255 </tr>
dan_ackme 14:85a2ed029f37 256 </table>
dan_ackme 14:85a2ed029f37 257 </div><div class="memdoc">
dan_ackme 14:85a2ed029f37 258
dan_ackme 14:85a2ed029f37 259 <p>Network RSSI signal level. </p>
dan_ackme 14:85a2ed029f37 260 <table class="fieldtable">
dan_ackme 14:85a2ed029f37 261 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggac5aead2b4cca0122a60168e75ea41d36a2911018510263b4d6db772cf6ea69385"></a>NETWORK_RSSI_EXCELLENT&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 262 <p>&gt; -20 dBm </p>
dan_ackme 14:85a2ed029f37 263 </td></tr>
dan_ackme 14:85a2ed029f37 264 <tr><td class="fieldname"><a class="anchor" id="ggac5aead2b4cca0122a60168e75ea41d36ad77f98cf80b81d4c5277672402c0b713"></a>NETWORK_RSSI_VERY_GOOD&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 265 <p>&gt; -35 dBm </p>
dan_ackme 14:85a2ed029f37 266 </td></tr>
dan_ackme 14:85a2ed029f37 267 <tr><td class="fieldname"><a class="anchor" id="ggac5aead2b4cca0122a60168e75ea41d36a5aa38a03f1ec4cdcdd1f0c41dfd19533"></a>NETWORK_RSSI_GOOD&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 268 <p>&gt; -50 dBm </p>
dan_ackme 14:85a2ed029f37 269 </td></tr>
dan_ackme 14:85a2ed029f37 270 <tr><td class="fieldname"><a class="anchor" id="ggac5aead2b4cca0122a60168e75ea41d36a2728fe7e544bee45b00ef95117085eae"></a>NETWORK_RSSI_POOR&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 271 <p>&gt; -70 dBm </p>
dan_ackme 14:85a2ed029f37 272 </td></tr>
dan_ackme 14:85a2ed029f37 273 <tr><td class="fieldname"><a class="anchor" id="ggac5aead2b4cca0122a60168e75ea41d36ab0e9cbbf4e2c6dee74d2639caef2cffa"></a>NETWORK_RSSI_VERY_POOR&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 274 <p>&lt; -71 dBm </p>
dan_ackme 14:85a2ed029f37 275 </td></tr>
dan_ackme 14:85a2ed029f37 276 <tr><td class="fieldname"><a class="anchor" id="ggac5aead2b4cca0122a60168e75ea41d36a095c1eef3bdeb16e33b1f6a976e9f6c4"></a>NETWORK_RSSI_UNKNOWN&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 277 <p>Not available. </p>
dan_ackme 14:85a2ed029f37 278 </td></tr>
dan_ackme 14:85a2ed029f37 279 </table>
dan_ackme 14:85a2ed029f37 280
dan_ackme 29:b6af04b77a56 281 <p>Definition at line <a class="el" href="_wiconnect_types_8h_source.html#l00267">267</a> of file <a class="el" href="_wiconnect_types_8h_source.html">WiconnectTypes.h</a>.</p>
dan_ackme 14:85a2ed029f37 282
dan_ackme 14:85a2ed029f37 283 </div>
dan_ackme 14:85a2ed029f37 284 </div>
dan_ackme 14:85a2ed029f37 285 <a class="anchor" id="gab448e57fc1a5e21cbba0283fd1a35d99"></a>
dan_ackme 14:85a2ed029f37 286 <div class="memitem">
dan_ackme 14:85a2ed029f37 287 <div class="memproto">
dan_ackme 14:85a2ed029f37 288 <table class="memname">
dan_ackme 14:85a2ed029f37 289 <tr>
dan_ackme 14:85a2ed029f37 290 <td class="memname">enum <a class="el" href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">wiconnect::NetworkStatus</a></td>
dan_ackme 14:85a2ed029f37 291 </tr>
dan_ackme 14:85a2ed029f37 292 </table>
dan_ackme 14:85a2ed029f37 293 </div><div class="memdoc">
dan_ackme 14:85a2ed029f37 294
dan_ackme 14:85a2ed029f37 295 <p>Network connection status. </p>
dan_ackme 14:85a2ed029f37 296 <table class="fieldtable">
dan_ackme 14:85a2ed029f37 297 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ggab448e57fc1a5e21cbba0283fd1a35d99a6a4dd5a93528f27eb983bf856b9f5067"></a>NETWORK_STATUS_DOWN&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 298 <p>Not connected to network. </p>
dan_ackme 14:85a2ed029f37 299 </td></tr>
dan_ackme 14:85a2ed029f37 300 <tr><td class="fieldname"><a class="anchor" id="ggab448e57fc1a5e21cbba0283fd1a35d99a8e40c9f169976770c3e65b9c0e44874c"></a>NETWORK_STATUS_WIFI_ONLY&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 301 <p>Connected to network but don't have IP address. </p>
dan_ackme 14:85a2ed029f37 302 </td></tr>
dan_ackme 14:85a2ed029f37 303 <tr><td class="fieldname"><a class="anchor" id="ggab448e57fc1a5e21cbba0283fd1a35d99a6d6f2fd76cab833e55bc398541c52b46"></a>NETWORK_STATUS_UP&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 304 <p>Conntected to network and have IP address. </p>
dan_ackme 14:85a2ed029f37 305 </td></tr>
dan_ackme 14:85a2ed029f37 306 <tr><td class="fieldname"><a class="anchor" id="ggab448e57fc1a5e21cbba0283fd1a35d99a2916360f96699b2bf42cf5e122562497"></a>NETWORK_STATUS_JOINING&#160;</td><td class="fielddoc">
dan_ackme 14:85a2ed029f37 307 <p>Joining a network. </p>
dan_ackme 14:85a2ed029f37 308 </td></tr>
dan_ackme 14:85a2ed029f37 309 </table>
dan_ackme 21:17bb3eddcbae 310
dan_ackme 29:b6af04b77a56 311 <p>Definition at line <a class="el" href="_wiconnect_types_8h_source.html#l00238">238</a> of file <a class="el" href="_wiconnect_types_8h_source.html">WiconnectTypes.h</a>.</p>
dan_ackme 14:85a2ed029f37 312
dan_ackme 14:85a2ed029f37 313 </div>
dan_ackme 14:85a2ed029f37 314 </div>
dan_ackme 14:85a2ed029f37 315 </div><!-- contents -->
dan_ackme 14:85a2ed029f37 316 </div><!-- doc-content -->
dan_ackme 14:85a2ed029f37 317 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 14:85a2ed029f37 318 <ul>
dan_ackme 14:85a2ed029f37 319 <li class="footer">&copy; ACKme Networks 2014</li>
dan_ackme 14:85a2ed029f37 320 </ul>
dan_ackme 14:85a2ed029f37 321 </div>
dan_ackme 14:85a2ed029f37 322 </body>
dan_ackme 14:85a2ed029f37 323 </html>