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

Diff: doc/html/group__types__network.html

Revision:
11:ea484e1b7fc4
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/html/group__types__network.html	Tue Aug 12 02:34:46 2014 -0700
@@ -0,0 +1,240 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen 1.8.7"/>
+<title>WiConnect Library: Network API</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="navtree.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="resize.js"></script>
+<script type="text/javascript" src="navtree.js"></script>
+<script type="text/javascript">
+  $(document).ready(initResizable);
+  $(window).load(resizeHeight);
+</script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/search.js"></script>
+<script type="text/javascript">
+  $(document).ready(function() { searchBox.OnSelectItem(0); });
+</script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+  <td style="padding-left: 0.5em;">
+   <div id="projectname">WiConnect Library
+   </div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.7 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+  <div id="navrow1" class="tabs">
+    <ul class="tablist">
+      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
+      <li><a href="modules.html"><span>Modules</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+      <li><a href="annotated.html"><span>Classes</span></a></li>
+      <li>
+        <div id="MSearchBox" class="MSearchBoxInactive">
+        <span class="left">
+          <img id="MSearchSelect" src="search/mag_sel.png"
+               onmouseover="return searchBox.OnSearchSelectShow()"
+               onmouseout="return searchBox.OnSearchSelectHide()"
+               alt=""/>
+          <input type="text" id="MSearchField" value="Search" accesskey="S"
+               onfocus="searchBox.OnSearchFieldFocus(true)" 
+               onblur="searchBox.OnSearchFieldFocus(false)" 
+               onkeyup="searchBox.OnSearchFieldChange(event)"/>
+          </span><span class="right">
+            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+          </span>
+        </div>
+      </li>
+    </ul>
+  </div>
+</div><!-- top -->
+<div id="side-nav" class="ui-resizable side-nav-resizable">
+  <div id="nav-tree">
+    <div id="nav-tree-contents">
+      <div id="nav-sync" class="sync"></div>
+    </div>
+  </div>
+  <div id="splitbar" style="-moz-user-select:none;" 
+       class="ui-resizable-handle">
+  </div>
+</div>
+<script type="text/javascript">
+$(document).ready(function(){initNavTree('group__types__network.html','');});
+</script>
+<div id="doc-content">
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+<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>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div class="header">
+  <div class="summary">
+<a href="#nested-classes">Classes</a> &#124;
+<a href="#typedef-members">Typedefs</a> &#124;
+<a href="#enum-members">Enumerations</a>  </div>
+  <div class="headertitle">
+<div class="title">Network API<div class="ingroups"><a class="el" href="group__types.html">Types</a></div></div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p>Network API Types.  
+<a href="#details">More...</a></p>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
+Classes</h2></td></tr>
+<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>
+<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>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<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>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<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>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<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>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<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>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
+Typedefs</h2></td></tr>
+<tr class="memitem:ga04b095d2e2f32a3fd23e346a4be969d8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga04b095d2e2f32a3fd23e346a4be969d8"></a>
+typedef char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__types__network.html#ga04b095d2e2f32a3fd23e346a4be969d8">wiconnect::MacAddressStrBuffer</a> [18]</td></tr>
+<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>
+<tr class="separator:ga04b095d2e2f32a3fd23e346a4be969d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga38e0a82235258f96340b9ce2c6e1426c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga38e0a82235258f96340b9ce2c6e1426c"></a>
+typedef char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__types__network.html#ga38e0a82235258f96340b9ce2c6e1426c">wiconnect::SsidStrBuffer</a> [129]</td></tr>
+<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>
+<tr class="separator:ga38e0a82235258f96340b9ce2c6e1426c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gaa68646bb07ee9f174097b60ac7327342"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa68646bb07ee9f174097b60ac7327342"></a>
+typedef char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__types__network.html#gaa68646bb07ee9f174097b60ac7327342">wiconnect::IpStrBuffer</a> [18]</td></tr>
+<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>
+<tr class="separator:gaa68646bb07ee9f174097b60ac7327342"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
+Enumerations</h2></td></tr>
+<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>, 
+<a class="el" href="group__types__network.html#ggab448e57fc1a5e21cbba0283fd1a35d99a8e40c9f169976770c3e65b9c0e44874c">wiconnect::NETWORK_STATUS_WIFI_ONLY</a>, 
+<a class="el" href="group__types__network.html#ggab448e57fc1a5e21cbba0283fd1a35d99a6d6f2fd76cab833e55bc398541c52b46">wiconnect::NETWORK_STATUS_UP</a>
+ }</td></tr>
+<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>
+<tr class="separator:gab448e57fc1a5e21cbba0283fd1a35d99"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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 />
+&#160;&#160;<a class="el" href="group__types__network.html#ggac5aead2b4cca0122a60168e75ea41d36a2911018510263b4d6db772cf6ea69385">wiconnect::NETWORK_RSSI_EXCELLENT</a> = 0, 
+<a class="el" href="group__types__network.html#ggac5aead2b4cca0122a60168e75ea41d36ad77f98cf80b81d4c5277672402c0b713">wiconnect::NETWORK_RSSI_VERY_GOOD</a> = 1, 
+<a class="el" href="group__types__network.html#ggac5aead2b4cca0122a60168e75ea41d36a5aa38a03f1ec4cdcdd1f0c41dfd19533">wiconnect::NETWORK_RSSI_GOOD</a> = 2, 
+<a class="el" href="group__types__network.html#ggac5aead2b4cca0122a60168e75ea41d36a2728fe7e544bee45b00ef95117085eae">wiconnect::NETWORK_RSSI_POOR</a> = 3, 
+<br />
+&#160;&#160;<a class="el" href="group__types__network.html#ggac5aead2b4cca0122a60168e75ea41d36ab0e9cbbf4e2c6dee74d2639caef2cffa">wiconnect::NETWORK_RSSI_VERY_POOR</a> = 4, 
+<a class="el" href="group__types__network.html#ggac5aead2b4cca0122a60168e75ea41d36a095c1eef3bdeb16e33b1f6a976e9f6c4">wiconnect::NETWORK_RSSI_UNKNOWN</a> = 5
+<br />
+ }</td></tr>
+<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>
+<tr class="separator:gac5aead2b4cca0122a60168e75ea41d36"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<tr class="memdesc:ga026bd11cd5df47b7022362243e2d553f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Network security type. <br /></td></tr>
+<tr class="separator:ga026bd11cd5df47b7022362243e2d553f"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<p>Network API Types. </p>
+<h2 class="groupheader">Enumeration Type Documentation</h2>
+<a class="anchor" id="gac5aead2b4cca0122a60168e75ea41d36"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">enum <a class="el" href="group__types__network.html#gac5aead2b4cca0122a60168e75ea41d36">wiconnect::NetworkSignalStrength</a></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Network RSSI signal level. </p>
+<table class="fieldtable">
+<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">
+<p>&gt; -20 dBm </p>
+</td></tr>
+<tr><td class="fieldname"><a class="anchor" id="ggac5aead2b4cca0122a60168e75ea41d36ad77f98cf80b81d4c5277672402c0b713"></a>NETWORK_RSSI_VERY_GOOD&#160;</td><td class="fielddoc">
+<p>&gt; -35 dBm </p>
+</td></tr>
+<tr><td class="fieldname"><a class="anchor" id="ggac5aead2b4cca0122a60168e75ea41d36a5aa38a03f1ec4cdcdd1f0c41dfd19533"></a>NETWORK_RSSI_GOOD&#160;</td><td class="fielddoc">
+<p>&gt; -50 dBm </p>
+</td></tr>
+<tr><td class="fieldname"><a class="anchor" id="ggac5aead2b4cca0122a60168e75ea41d36a2728fe7e544bee45b00ef95117085eae"></a>NETWORK_RSSI_POOR&#160;</td><td class="fielddoc">
+<p>&gt; -70 dBm </p>
+</td></tr>
+<tr><td class="fieldname"><a class="anchor" id="ggac5aead2b4cca0122a60168e75ea41d36ab0e9cbbf4e2c6dee74d2639caef2cffa"></a>NETWORK_RSSI_VERY_POOR&#160;</td><td class="fielddoc">
+<p>&lt; -71 dBm </p>
+</td></tr>
+<tr><td class="fieldname"><a class="anchor" id="ggac5aead2b4cca0122a60168e75ea41d36a095c1eef3bdeb16e33b1f6a976e9f6c4"></a>NETWORK_RSSI_UNKNOWN&#160;</td><td class="fielddoc">
+<p>Not available. </p>
+</td></tr>
+</table>
+
+</div>
+</div>
+<a class="anchor" id="gab448e57fc1a5e21cbba0283fd1a35d99"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">enum <a class="el" href="group__types__network.html#gab448e57fc1a5e21cbba0283fd1a35d99">wiconnect::NetworkStatus</a></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Network connection status. </p>
+<table class="fieldtable">
+<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">
+<p>Not connected to network. </p>
+</td></tr>
+<tr><td class="fieldname"><a class="anchor" id="ggab448e57fc1a5e21cbba0283fd1a35d99a8e40c9f169976770c3e65b9c0e44874c"></a>NETWORK_STATUS_WIFI_ONLY&#160;</td><td class="fielddoc">
+<p>Connected to network but don't have IP address. </p>
+</td></tr>
+<tr><td class="fieldname"><a class="anchor" id="ggab448e57fc1a5e21cbba0283fd1a35d99a6d6f2fd76cab833e55bc398541c52b46"></a>NETWORK_STATUS_UP&#160;</td><td class="fielddoc">
+<p>Conntected to network and have IP address. </p>
+</td></tr>
+</table>
+
+</div>
+</div>
+</div><!-- contents -->
+</div><!-- doc-content -->
+<!-- start footer part -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    <li class="footer">Generated on Tue Aug 12 2014 02:15:22 for WiConnect Library by
+    <a href="http://www.doxygen.org/index.html">
+    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
+  </ul>
+</div>
+</body>
+</html>