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

Committer:
dan_ackme
Date:
Tue Aug 12 02:34:46 2014 -0700
Revision:
11:ea484e1b7fc4
updated documnetation

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 11:ea484e1b7fc4 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
dan_ackme 11:ea484e1b7fc4 2 <html xmlns="http://www.w3.org/1999/xhtml">
dan_ackme 11:ea484e1b7fc4 3 <head>
dan_ackme 11:ea484e1b7fc4 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
dan_ackme 11:ea484e1b7fc4 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
dan_ackme 11:ea484e1b7fc4 6 <meta name="generator" content="Doxygen 1.8.7"/>
dan_ackme 11:ea484e1b7fc4 7 <title>WiConnect Library: Network API</title>
dan_ackme 11:ea484e1b7fc4 8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
dan_ackme 11:ea484e1b7fc4 9 <script type="text/javascript" src="jquery.js"></script>
dan_ackme 11:ea484e1b7fc4 10 <script type="text/javascript" src="dynsections.js"></script>
dan_ackme 11:ea484e1b7fc4 11 <link href="navtree.css" rel="stylesheet" type="text/css"/>
dan_ackme 11:ea484e1b7fc4 12 <script type="text/javascript" src="resize.js"></script>
dan_ackme 11:ea484e1b7fc4 13 <script type="text/javascript" src="navtree.js"></script>
dan_ackme 11:ea484e1b7fc4 14 <script type="text/javascript">
dan_ackme 11:ea484e1b7fc4 15 $(document).ready(initResizable);
dan_ackme 11:ea484e1b7fc4 16 $(window).load(resizeHeight);
dan_ackme 11:ea484e1b7fc4 17 </script>
dan_ackme 11:ea484e1b7fc4 18 <link href="search/search.css" rel="stylesheet" type="text/css"/>
dan_ackme 11:ea484e1b7fc4 19 <script type="text/javascript" src="search/search.js"></script>
dan_ackme 11:ea484e1b7fc4 20 <script type="text/javascript">
dan_ackme 11:ea484e1b7fc4 21 $(document).ready(function() { searchBox.OnSelectItem(0); });
dan_ackme 11:ea484e1b7fc4 22 </script>
dan_ackme 11:ea484e1b7fc4 23 <link href="doxygen.css" rel="stylesheet" type="text/css" />
dan_ackme 11:ea484e1b7fc4 24 </head>
dan_ackme 11:ea484e1b7fc4 25 <body>
dan_ackme 11:ea484e1b7fc4 26 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
dan_ackme 11:ea484e1b7fc4 27 <div id="titlearea">
dan_ackme 11:ea484e1b7fc4 28 <table cellspacing="0" cellpadding="0">
dan_ackme 11:ea484e1b7fc4 29 <tbody>
dan_ackme 11:ea484e1b7fc4 30 <tr style="height: 56px;">
dan_ackme 11:ea484e1b7fc4 31 <td style="padding-left: 0.5em;">
dan_ackme 11:ea484e1b7fc4 32 <div id="projectname">WiConnect Library
dan_ackme 11:ea484e1b7fc4 33 </div>
dan_ackme 11:ea484e1b7fc4 34 </td>
dan_ackme 11:ea484e1b7fc4 35 </tr>
dan_ackme 11:ea484e1b7fc4 36 </tbody>
dan_ackme 11:ea484e1b7fc4 37 </table>
dan_ackme 11:ea484e1b7fc4 38 </div>
dan_ackme 11:ea484e1b7fc4 39 <!-- end header part -->
dan_ackme 11:ea484e1b7fc4 40 <!-- Generated by Doxygen 1.8.7 -->
dan_ackme 11:ea484e1b7fc4 41 <script type="text/javascript">
dan_ackme 11:ea484e1b7fc4 42 var searchBox = new SearchBox("searchBox", "search",false,'Search');
dan_ackme 11:ea484e1b7fc4 43 </script>
dan_ackme 11:ea484e1b7fc4 44 <div id="navrow1" class="tabs">
dan_ackme 11:ea484e1b7fc4 45 <ul class="tablist">
dan_ackme 11:ea484e1b7fc4 46 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
dan_ackme 11:ea484e1b7fc4 47 <li><a href="modules.html"><span>Modules</span></a></li>
dan_ackme 11:ea484e1b7fc4 48 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
dan_ackme 11:ea484e1b7fc4 49 <li><a href="annotated.html"><span>Classes</span></a></li>
dan_ackme 11:ea484e1b7fc4 50 <li>
dan_ackme 11:ea484e1b7fc4 51 <div id="MSearchBox" class="MSearchBoxInactive">
dan_ackme 11:ea484e1b7fc4 52 <span class="left">
dan_ackme 11:ea484e1b7fc4 53 <img id="MSearchSelect" src="search/mag_sel.png"
dan_ackme 11:ea484e1b7fc4 54 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 11:ea484e1b7fc4 55 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 11:ea484e1b7fc4 56 alt=""/>
dan_ackme 11:ea484e1b7fc4 57 <input type="text" id="MSearchField" value="Search" accesskey="S"
dan_ackme 11:ea484e1b7fc4 58 onfocus="searchBox.OnSearchFieldFocus(true)"
dan_ackme 11:ea484e1b7fc4 59 onblur="searchBox.OnSearchFieldFocus(false)"
dan_ackme 11:ea484e1b7fc4 60 onkeyup="searchBox.OnSearchFieldChange(event)"/>
dan_ackme 11:ea484e1b7fc4 61 </span><span class="right">
dan_ackme 11:ea484e1b7fc4 62 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
dan_ackme 11:ea484e1b7fc4 63 </span>
dan_ackme 11:ea484e1b7fc4 64 </div>
dan_ackme 11:ea484e1b7fc4 65 </li>
dan_ackme 11:ea484e1b7fc4 66 </ul>
dan_ackme 11:ea484e1b7fc4 67 </div>
dan_ackme 11:ea484e1b7fc4 68 </div><!-- top -->
dan_ackme 11:ea484e1b7fc4 69 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 11:ea484e1b7fc4 70 <div id="nav-tree">
dan_ackme 11:ea484e1b7fc4 71 <div id="nav-tree-contents">
dan_ackme 11:ea484e1b7fc4 72 <div id="nav-sync" class="sync"></div>
dan_ackme 11:ea484e1b7fc4 73 </div>
dan_ackme 11:ea484e1b7fc4 74 </div>
dan_ackme 11:ea484e1b7fc4 75 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 11:ea484e1b7fc4 76 class="ui-resizable-handle">
dan_ackme 11:ea484e1b7fc4 77 </div>
dan_ackme 11:ea484e1b7fc4 78 </div>
dan_ackme 11:ea484e1b7fc4 79 <script type="text/javascript">
dan_ackme 11:ea484e1b7fc4 80 $(document).ready(function(){initNavTree('group__types__network.html','');});
dan_ackme 11:ea484e1b7fc4 81 </script>
dan_ackme 11:ea484e1b7fc4 82 <div id="doc-content">
dan_ackme 11:ea484e1b7fc4 83 <!-- window showing the filter options -->
dan_ackme 11:ea484e1b7fc4 84 <div id="MSearchSelectWindow"
dan_ackme 11:ea484e1b7fc4 85 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 11:ea484e1b7fc4 86 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 11:ea484e1b7fc4 87 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 11:ea484e1b7fc4 88 <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 11:ea484e1b7fc4 89
dan_ackme 11:ea484e1b7fc4 90 <!-- iframe showing the search results (closed by default) -->
dan_ackme 11:ea484e1b7fc4 91 <div id="MSearchResultsWindow">
dan_ackme 11:ea484e1b7fc4 92 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 11:ea484e1b7fc4 93 name="MSearchResults" id="MSearchResults">
dan_ackme 11:ea484e1b7fc4 94 </iframe>
dan_ackme 11:ea484e1b7fc4 95 </div>
dan_ackme 11:ea484e1b7fc4 96
dan_ackme 11:ea484e1b7fc4 97 <div class="header">
dan_ackme 11:ea484e1b7fc4 98 <div class="summary">
dan_ackme 11:ea484e1b7fc4 99 <a href="#nested-classes">Classes</a> &#124;
dan_ackme 11:ea484e1b7fc4 100 <a href="#typedef-members">Typedefs</a> &#124;
dan_ackme 11:ea484e1b7fc4 101 <a href="#enum-members">Enumerations</a> </div>
dan_ackme 11:ea484e1b7fc4 102 <div class="headertitle">
dan_ackme 11:ea484e1b7fc4 103 <div class="title">Network API<div class="ingroups"><a class="el" href="group__types.html">Types</a></div></div> </div>
dan_ackme 11:ea484e1b7fc4 104 </div><!--header-->
dan_ackme 11:ea484e1b7fc4 105 <div class="contents">
dan_ackme 11:ea484e1b7fc4 106
dan_ackme 11:ea484e1b7fc4 107 <p>Network API Types.
dan_ackme 11:ea484e1b7fc4 108 <a href="#details">More...</a></p>
dan_ackme 11:ea484e1b7fc4 109 <table class="memberdecls">
dan_ackme 11:ea484e1b7fc4 110 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
dan_ackme 11:ea484e1b7fc4 111 Classes</h2></td></tr>
dan_ackme 11:ea484e1b7fc4 112 <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 11:ea484e1b7fc4 113 <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 11:ea484e1b7fc4 114 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 115 <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 11:ea484e1b7fc4 116 <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 11:ea484e1b7fc4 117 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 118 <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 11:ea484e1b7fc4 119 <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 11:ea484e1b7fc4 120 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 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_scan_result.html">wiconnect::ScanResult</a></td></tr>
dan_ackme 11:ea484e1b7fc4 122 <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 11:ea484e1b7fc4 123 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 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_scan_result_list.html">wiconnect::ScanResultList</a></td></tr>
dan_ackme 11:ea484e1b7fc4 125 <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 11:ea484e1b7fc4 126 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 127 </table><table class="memberdecls">
dan_ackme 11:ea484e1b7fc4 128 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
dan_ackme 11:ea484e1b7fc4 129 Typedefs</h2></td></tr>
dan_ackme 11:ea484e1b7fc4 130 <tr class="memitem:ga04b095d2e2f32a3fd23e346a4be969d8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga04b095d2e2f32a3fd23e346a4be969d8"></a>
dan_ackme 11:ea484e1b7fc4 131 typedef char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__types__network.html#ga04b095d2e2f32a3fd23e346a4be969d8">wiconnect::MacAddressStrBuffer</a> [18]</td></tr>
dan_ackme 11:ea484e1b7fc4 132 <tr class="memdesc:ga04b095d2e2f32a3fd23e346a4be969d8"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structwiconnect_1_1_buffer.html" title="Generic buffer type. ">Buffer</a> to hold a MAC address string. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 133 <tr class="separator:ga04b095d2e2f32a3fd23e346a4be969d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 134 <tr class="memitem:ga38e0a82235258f96340b9ce2c6e1426c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga38e0a82235258f96340b9ce2c6e1426c"></a>
dan_ackme 11:ea484e1b7fc4 135 typedef char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__types__network.html#ga38e0a82235258f96340b9ce2c6e1426c">wiconnect::SsidStrBuffer</a> [129]</td></tr>
dan_ackme 11:ea484e1b7fc4 136 <tr class="memdesc:ga38e0a82235258f96340b9ce2c6e1426c"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structwiconnect_1_1_buffer.html" title="Generic buffer type. ">Buffer</a> to hold a SSID string. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 137 <tr class="separator:ga38e0a82235258f96340b9ce2c6e1426c"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 138 <tr class="memitem:gaa68646bb07ee9f174097b60ac7327342"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa68646bb07ee9f174097b60ac7327342"></a>
dan_ackme 11:ea484e1b7fc4 139 typedef char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__types__network.html#gaa68646bb07ee9f174097b60ac7327342">wiconnect::IpStrBuffer</a> [18]</td></tr>
dan_ackme 11:ea484e1b7fc4 140 <tr class="memdesc:gaa68646bb07ee9f174097b60ac7327342"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structwiconnect_1_1_buffer.html" title="Generic buffer type. ">Buffer</a> to hold an IP address string. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 141 <tr class="separator:gaa68646bb07ee9f174097b60ac7327342"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 142 </table><table class="memberdecls">
dan_ackme 11:ea484e1b7fc4 143 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
dan_ackme 11:ea484e1b7fc4 144 Enumerations</h2></td></tr>
dan_ackme 11:ea484e1b7fc4 145 <tr class="memitem:gab448e57fc1a5e21cbba0283fd1a35d99"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__types__network.html#gab448e57fc1a5e21cbba0283fd1a35d99">wiconnect::NetworkStatus</a> { <a class="el" href="group__types__network.html#ggab448e57fc1a5e21cbba0283fd1a35d99a6a4dd5a93528f27eb983bf856b9f5067">wiconnect::NETWORK_STATUS_DOWN</a>,
dan_ackme 11:ea484e1b7fc4 146 <a class="el" href="group__types__network.html#ggab448e57fc1a5e21cbba0283fd1a35d99a8e40c9f169976770c3e65b9c0e44874c">wiconnect::NETWORK_STATUS_WIFI_ONLY</a>,
dan_ackme 11:ea484e1b7fc4 147 <a class="el" href="group__types__network.html#ggab448e57fc1a5e21cbba0283fd1a35d99a6d6f2fd76cab833e55bc398541c52b46">wiconnect::NETWORK_STATUS_UP</a>
dan_ackme 11:ea484e1b7fc4 148 }</td></tr>
dan_ackme 11:ea484e1b7fc4 149 <tr class="memdesc:gab448e57fc1a5e21cbba0283fd1a35d99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Network connection status. <a href="group__types__network.html#gab448e57fc1a5e21cbba0283fd1a35d99">More...</a><br /></td></tr>
dan_ackme 11:ea484e1b7fc4 150 <tr class="separator:gab448e57fc1a5e21cbba0283fd1a35d99"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 151 <tr class="memitem:gac5aead2b4cca0122a60168e75ea41d36"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__types__network.html#gac5aead2b4cca0122a60168e75ea41d36">wiconnect::NetworkSignalStrength</a> { <br />
dan_ackme 11:ea484e1b7fc4 152 &#160;&#160;<a class="el" href="group__types__network.html#ggac5aead2b4cca0122a60168e75ea41d36a2911018510263b4d6db772cf6ea69385">wiconnect::NETWORK_RSSI_EXCELLENT</a> = 0,
dan_ackme 11:ea484e1b7fc4 153 <a class="el" href="group__types__network.html#ggac5aead2b4cca0122a60168e75ea41d36ad77f98cf80b81d4c5277672402c0b713">wiconnect::NETWORK_RSSI_VERY_GOOD</a> = 1,
dan_ackme 11:ea484e1b7fc4 154 <a class="el" href="group__types__network.html#ggac5aead2b4cca0122a60168e75ea41d36a5aa38a03f1ec4cdcdd1f0c41dfd19533">wiconnect::NETWORK_RSSI_GOOD</a> = 2,
dan_ackme 11:ea484e1b7fc4 155 <a class="el" href="group__types__network.html#ggac5aead2b4cca0122a60168e75ea41d36a2728fe7e544bee45b00ef95117085eae">wiconnect::NETWORK_RSSI_POOR</a> = 3,
dan_ackme 11:ea484e1b7fc4 156 <br />
dan_ackme 11:ea484e1b7fc4 157 &#160;&#160;<a class="el" href="group__types__network.html#ggac5aead2b4cca0122a60168e75ea41d36ab0e9cbbf4e2c6dee74d2639caef2cffa">wiconnect::NETWORK_RSSI_VERY_POOR</a> = 4,
dan_ackme 11:ea484e1b7fc4 158 <a class="el" href="group__types__network.html#ggac5aead2b4cca0122a60168e75ea41d36a095c1eef3bdeb16e33b1f6a976e9f6c4">wiconnect::NETWORK_RSSI_UNKNOWN</a> = 5
dan_ackme 11:ea484e1b7fc4 159 <br />
dan_ackme 11:ea484e1b7fc4 160 }</td></tr>
dan_ackme 11:ea484e1b7fc4 161 <tr class="memdesc:gac5aead2b4cca0122a60168e75ea41d36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Network RSSI signal level. <a href="group__types__network.html#gac5aead2b4cca0122a60168e75ea41d36">More...</a><br /></td></tr>
dan_ackme 11:ea484e1b7fc4 162 <tr class="separator:gac5aead2b4cca0122a60168e75ea41d36"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 163 <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__types__network.html#ga026bd11cd5df47b7022362243e2d553f">wiconnect::NetworkSecurity</a> </td></tr>
dan_ackme 11:ea484e1b7fc4 164 <tr class="memdesc:ga026bd11cd5df47b7022362243e2d553f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Network security type. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 165 <tr class="separator:ga026bd11cd5df47b7022362243e2d553f"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 166 </table>
dan_ackme 11:ea484e1b7fc4 167 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 11:ea484e1b7fc4 168 <p>Network API Types. </p>
dan_ackme 11:ea484e1b7fc4 169 <h2 class="groupheader">Enumeration Type Documentation</h2>
dan_ackme 11:ea484e1b7fc4 170 <a class="anchor" id="gac5aead2b4cca0122a60168e75ea41d36"></a>
dan_ackme 11:ea484e1b7fc4 171 <div class="memitem">
dan_ackme 11:ea484e1b7fc4 172 <div class="memproto">
dan_ackme 11:ea484e1b7fc4 173 <table class="memname">
dan_ackme 11:ea484e1b7fc4 174 <tr>
dan_ackme 11:ea484e1b7fc4 175 <td class="memname">enum <a class="el" href="group__types__network.html#gac5aead2b4cca0122a60168e75ea41d36">wiconnect::NetworkSignalStrength</a></td>
dan_ackme 11:ea484e1b7fc4 176 </tr>
dan_ackme 11:ea484e1b7fc4 177 </table>
dan_ackme 11:ea484e1b7fc4 178 </div><div class="memdoc">
dan_ackme 11:ea484e1b7fc4 179
dan_ackme 11:ea484e1b7fc4 180 <p>Network RSSI signal level. </p>
dan_ackme 11:ea484e1b7fc4 181 <table class="fieldtable">
dan_ackme 11:ea484e1b7fc4 182 <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 11:ea484e1b7fc4 183 <p>&gt; -20 dBm </p>
dan_ackme 11:ea484e1b7fc4 184 </td></tr>
dan_ackme 11:ea484e1b7fc4 185 <tr><td class="fieldname"><a class="anchor" id="ggac5aead2b4cca0122a60168e75ea41d36ad77f98cf80b81d4c5277672402c0b713"></a>NETWORK_RSSI_VERY_GOOD&#160;</td><td class="fielddoc">
dan_ackme 11:ea484e1b7fc4 186 <p>&gt; -35 dBm </p>
dan_ackme 11:ea484e1b7fc4 187 </td></tr>
dan_ackme 11:ea484e1b7fc4 188 <tr><td class="fieldname"><a class="anchor" id="ggac5aead2b4cca0122a60168e75ea41d36a5aa38a03f1ec4cdcdd1f0c41dfd19533"></a>NETWORK_RSSI_GOOD&#160;</td><td class="fielddoc">
dan_ackme 11:ea484e1b7fc4 189 <p>&gt; -50 dBm </p>
dan_ackme 11:ea484e1b7fc4 190 </td></tr>
dan_ackme 11:ea484e1b7fc4 191 <tr><td class="fieldname"><a class="anchor" id="ggac5aead2b4cca0122a60168e75ea41d36a2728fe7e544bee45b00ef95117085eae"></a>NETWORK_RSSI_POOR&#160;</td><td class="fielddoc">
dan_ackme 11:ea484e1b7fc4 192 <p>&gt; -70 dBm </p>
dan_ackme 11:ea484e1b7fc4 193 </td></tr>
dan_ackme 11:ea484e1b7fc4 194 <tr><td class="fieldname"><a class="anchor" id="ggac5aead2b4cca0122a60168e75ea41d36ab0e9cbbf4e2c6dee74d2639caef2cffa"></a>NETWORK_RSSI_VERY_POOR&#160;</td><td class="fielddoc">
dan_ackme 11:ea484e1b7fc4 195 <p>&lt; -71 dBm </p>
dan_ackme 11:ea484e1b7fc4 196 </td></tr>
dan_ackme 11:ea484e1b7fc4 197 <tr><td class="fieldname"><a class="anchor" id="ggac5aead2b4cca0122a60168e75ea41d36a095c1eef3bdeb16e33b1f6a976e9f6c4"></a>NETWORK_RSSI_UNKNOWN&#160;</td><td class="fielddoc">
dan_ackme 11:ea484e1b7fc4 198 <p>Not available. </p>
dan_ackme 11:ea484e1b7fc4 199 </td></tr>
dan_ackme 11:ea484e1b7fc4 200 </table>
dan_ackme 11:ea484e1b7fc4 201
dan_ackme 11:ea484e1b7fc4 202 </div>
dan_ackme 11:ea484e1b7fc4 203 </div>
dan_ackme 11:ea484e1b7fc4 204 <a class="anchor" id="gab448e57fc1a5e21cbba0283fd1a35d99"></a>
dan_ackme 11:ea484e1b7fc4 205 <div class="memitem">
dan_ackme 11:ea484e1b7fc4 206 <div class="memproto">
dan_ackme 11:ea484e1b7fc4 207 <table class="memname">
dan_ackme 11:ea484e1b7fc4 208 <tr>
dan_ackme 11:ea484e1b7fc4 209 <td class="memname">enum <a class="el" href="group__types__network.html#gab448e57fc1a5e21cbba0283fd1a35d99">wiconnect::NetworkStatus</a></td>
dan_ackme 11:ea484e1b7fc4 210 </tr>
dan_ackme 11:ea484e1b7fc4 211 </table>
dan_ackme 11:ea484e1b7fc4 212 </div><div class="memdoc">
dan_ackme 11:ea484e1b7fc4 213
dan_ackme 11:ea484e1b7fc4 214 <p>Network connection status. </p>
dan_ackme 11:ea484e1b7fc4 215 <table class="fieldtable">
dan_ackme 11:ea484e1b7fc4 216 <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 11:ea484e1b7fc4 217 <p>Not connected to network. </p>
dan_ackme 11:ea484e1b7fc4 218 </td></tr>
dan_ackme 11:ea484e1b7fc4 219 <tr><td class="fieldname"><a class="anchor" id="ggab448e57fc1a5e21cbba0283fd1a35d99a8e40c9f169976770c3e65b9c0e44874c"></a>NETWORK_STATUS_WIFI_ONLY&#160;</td><td class="fielddoc">
dan_ackme 11:ea484e1b7fc4 220 <p>Connected to network but don't have IP address. </p>
dan_ackme 11:ea484e1b7fc4 221 </td></tr>
dan_ackme 11:ea484e1b7fc4 222 <tr><td class="fieldname"><a class="anchor" id="ggab448e57fc1a5e21cbba0283fd1a35d99a6d6f2fd76cab833e55bc398541c52b46"></a>NETWORK_STATUS_UP&#160;</td><td class="fielddoc">
dan_ackme 11:ea484e1b7fc4 223 <p>Conntected to network and have IP address. </p>
dan_ackme 11:ea484e1b7fc4 224 </td></tr>
dan_ackme 11:ea484e1b7fc4 225 </table>
dan_ackme 11:ea484e1b7fc4 226
dan_ackme 11:ea484e1b7fc4 227 </div>
dan_ackme 11:ea484e1b7fc4 228 </div>
dan_ackme 11:ea484e1b7fc4 229 </div><!-- contents -->
dan_ackme 11:ea484e1b7fc4 230 </div><!-- doc-content -->
dan_ackme 11:ea484e1b7fc4 231 <!-- start footer part -->
dan_ackme 11:ea484e1b7fc4 232 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 11:ea484e1b7fc4 233 <ul>
dan_ackme 11:ea484e1b7fc4 234 <li class="footer">Generated on Tue Aug 12 2014 02:15:22 for WiConnect Library by
dan_ackme 11:ea484e1b7fc4 235 <a href="http://www.doxygen.org/index.html">
dan_ackme 11:ea484e1b7fc4 236 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
dan_ackme 11:ea484e1b7fc4 237 </ul>
dan_ackme 11:ea484e1b7fc4 238 </div>
dan_ackme 11:ea484e1b7fc4 239 </body>
dan_ackme 11:ea484e1b7fc4 240 </html>