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/classwiconnect_1_1_network_interface-members.html

Committer:
dan_ackme
Date:
2014-08-23
Revision:
17:7268f365676b
Parent:
13:2b51f5267c92
Child:
26:8067e3d463d3

File content as of revision 17:7268f365676b:

<!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"/>
<title>ACKme WiConnect Host Library</title>
<link rel="icon" href="favicon.ico" type="image/x-icon">
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
<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" style="font-family:verdana;">
    <table border='0' cellpadding='0' cellspacing='0' width="98%">
      <tr style="height:20px"><td>&nbsp;</td></tr>
      <tr style="border-collapse: collapse; padding: 0;">
        <td style="width:20px"></td>
        <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
        <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
        WiConnect Host Library- API Reference Guide</td>
        <td style="width:20px"></td>
      </tr>
      <tr><td>&nbsp;</td></tr>
    </table>
</div><!-- 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>Library&#160;Overview</span></a></li>
      <li><a href="modules.html"><span>Library&#160;API</span></a></li>
      <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="http://wiconnect.ack.me/1.2/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
      <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</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 id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></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('classwiconnect_1_1_network_interface.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="headertitle">
<div class="title">wiconnect::NetworkInterface Member List</div>  </div>
</div><!--header-->
<div class="contents">

<p>This is the complete list of members for <a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a>, including all inherited members.</p>
<table class="directory">
  <tr class="even"><td class="entry"><a class="el" href="group__api__network__settings.html#ga70ec796b88eb6f8e7990dbf3eb2f2eff">getDhcpEnabled</a>(bool *enabledPtr)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"></td></tr>
  <tr><td class="entry"><a class="el" href="group__api__network__settings.html#ga0b8fc3d5be0bae9ffcdc1b4b9aee6290">getIpAddress</a>(char *buffer=NULL)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"></td></tr>
  <tr class="even"><td class="entry"><a class="el" href="group__api__network__settings.html#ga291aef702f1c10bf2970394e3458022b">getIpSettings</a>(uint32_t *ip, uint32_t *netmask, uint32_t *gateway)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"></td></tr>
  <tr><td class="entry"><a class="el" href="group__api__network__wlan.html#ga047ba9670f60406466391cec5bdd28e5">getNetworkStatus</a>(NetworkStatus *statusPtr)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"></td></tr>
  <tr class="even"><td class="entry"><a class="el" href="group__api__network__settings.html#gaba16b9918e55c08285cf5b8b50dbabea">getSignalStrength</a>(NetworkSignalStrength *signalStrengthPtr)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"></td></tr>
  <tr><td class="entry"><a class="el" href="group__conversion__util.html#gaff8b0af70f4d4be792b943ad3af27303">ipToStr</a>(uint32_t ip, char *ipStrBuffer=NULL)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
  <tr class="even"><td class="entry"><a class="el" href="group__api__network__setup.html#gab52d3a01427d0e8bd52460d992144f65">isWebSetupRunning</a>(bool *isRunningPtr)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"></td></tr>
  <tr><td class="entry"><a class="el" href="group__api__network__wlan.html#gac439d0af5a17da32d405e25dcba83d16">join</a>(const char *ssid=NULL, const char *password=NULL, const Callback &amp;completeHandler=Callback())</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"></td></tr>
  <tr class="even"><td class="entry"><a class="el" href="group__api__network__wlan.html#ga14dc0f4fa58a7ebb25b77fae22052328">leave</a>()</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"></td></tr>
  <tr><td class="entry"><a class="el" href="group__api__network__util.html#ga1770babfc2abc6da7c085ef92709ee89">lookup</a>(const char *domain, uint32_t *ipAddressPtr)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"></td></tr>
  <tr class="even"><td class="entry"><a class="el" href="group__conversion__util.html#ga13ecaf390b4bf4a68b51a6b18e669134">macAddressToStr</a>(const MacAddress *macAddress, char *macStrBuffer=NULL)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
  <tr><td class="entry"><a class="el" href="group__conversion__util.html#gae02c549079cfb0350117cd6343a3d66f">networkSecurityToStr</a>(NetworkSecurity security)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
  <tr class="even"><td class="entry"><a class="el" href="group__conversion__util.html#gacff5a4927d79e8b4c0d5a3050f5950b0">networkStatusToStr</a>(NetworkStatus status)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
  <tr><td class="entry"><a class="el" href="group__api__network__util.html#ga1da909dadb6f0e90218927ed350f72bc">ping</a>(const char *domain=NULL, uint32_t *timeMsPtr=NULL)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"></td></tr>
  <tr class="even"><td class="entry"><a class="el" href="group__conversion__util.html#ga6216eed4cc05c37ce1ed13a0fbb6acd8">rssiToSignalStrength</a>(int rssi)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
  <tr><td class="entry"><a class="el" href="group__api__network__util.html#gacdf014d8aca9de33dbc1563c6bb1f956">scan</a>(ScanResultList &amp;resultList, const uint8_t *channelList=NULL, const char *ssid=NULL)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"></td></tr>
  <tr class="even"><td class="entry"><a class="el" href="group__api__network__settings.html#ga65eb99f880ed739d0f3cd393e5b56eaf">setDhcpEnabled</a>(bool enabled)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"></td></tr>
  <tr><td class="entry"><a class="el" href="group__api__network__settings.html#ga2f7ec21084d3f2835d9c1c201915a9e0">setIpSettings</a>(uint32_t ip, uint32_t netmask, uint32_t gateway)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"></td></tr>
  <tr class="even"><td class="entry"><a class="el" href="group__api__network__settings.html#gaa418175dd3d06b870f3dd8e035cb4dd0">setIpSettings</a>(const char *ip, const char *netmask, const char *gateway)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"></td></tr>
  <tr><td class="entry"><a class="el" href="group__conversion__util.html#gad4661f859cfadbe193793898671043c9">signalStrengthToStr</a>(NetworkSignalStrength signalStrenth)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
  <tr class="even"><td class="entry"><a class="el" href="group__conversion__util.html#gafce7929a10e16cf9be7307a2f97bef3f">ssidToStr</a>(const Ssid *ssid, char *ssidStrBuffer=NULL)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
  <tr><td class="entry"><a class="el" href="group__api__network__setup.html#gaea3e133f2ee8c95d8d108c15561f3847">startWebSetup</a>(const char *ssid=NULL, const char *password=NULL, const Callback &amp;completeHandler=Callback())</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"></td></tr>
  <tr class="even"><td class="entry"><a class="el" href="group__api__network__setup.html#gac5ca67b7bfa587935b5619e441dc8d8a">stopWebSetup</a>()</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"></td></tr>
  <tr><td class="entry"><a class="el" href="group__conversion__util.html#ga93bdb8669a70adaa61dc76073ce66591">strToIp</a>(const char *str, uint32_t *intPtr)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
  <tr class="even"><td class="entry"><a class="el" href="group__conversion__util.html#ga347f05073370d6872a5cdac74de39b1b">strToMacAddress</a>(const char *str, MacAddress *macAddress)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
  <tr><td class="entry"><a class="el" href="group__conversion__util.html#gad7d49be19f9ca91bc129668dd50d9e57">strToNetworkSecurity</a>(const char *str)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
  <tr class="even"><td class="entry"><a class="el" href="group__conversion__util.html#ga6a479a58591ead92dcf0586e11fcad17">strToSsid</a>(const char *str, Ssid *ssid)</td><td class="entry"><a class="el" href="classwiconnect_1_1_network_interface.html">wiconnect::NetworkInterface</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">&copy; ACKme Networks 2014</li>
  </ul>
</div>
</body>
</html>