ACKme
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/mbed/html/classwiconnect_1_1_network_interface.html
- Committer:
- dan_ackme
- Date:
- 2014-11-26
- Revision:
- 34:2616445d0823
File content as of revision 34:2616445d0823:
<!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> </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> </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 Overview</span></a></li>
<li><a href="modules.html"><span>Library API</span></a></li>
<li><a href="examples.html"><span>API Examples</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect Reference Manual</span></a></li>
<li><a href="http://www.ack.me/WiConnect"><span>ACKme Website</span></a></li>
<li><a href="http://developer.mbed.org/teams/ACKme/code/WiConnect/"><span>WiConnect Repository</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 List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </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="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classwiconnect_1_1_network_interface-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">wiconnect::NetworkInterface Class Reference<div class="ingroups"><a class="el" href="group__api__network__types.html">Types</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>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></p>
<p><code>#include <<a class="el" href="_network_interface_8h_source.html">NetworkInterface.h</a>></code></p>
<p>Inherited by <a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:gaea3e133f2ee8c95d8d108c15561f3847"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__setup.html#gaea3e133f2ee8c95d8d108c15561f3847">startWebSetup</a> (const char *ssid=NULL, const char *password=NULL, const <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> &completeHandler=<a class="el" href="classwiconnect_1_1_callback.html">Callback</a>())</td></tr>
<tr class="memdesc:gaea3e133f2ee8c95d8d108c15561f3847"><td class="mdescLeft"> </td><td class="mdescRight">Start the WiConnect WiFi module 'web setup' feature. <a href="group__api__network__setup.html#gaea3e133f2ee8c95d8d108c15561f3847">More...</a><br /></td></tr>
<tr class="separator:gaea3e133f2ee8c95d8d108c15561f3847"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac5ca67b7bfa587935b5619e441dc8d8a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__setup.html#gac5ca67b7bfa587935b5619e441dc8d8a">stopWebSetup</a> ()</td></tr>
<tr class="memdesc:gac5ca67b7bfa587935b5619e441dc8d8a"><td class="mdescLeft"> </td><td class="mdescRight">Stop the WiConnect WiFi module 'web setup' feature. <a href="group__api__network__setup.html#gac5ca67b7bfa587935b5619e441dc8d8a">More...</a><br /></td></tr>
<tr class="separator:gac5ca67b7bfa587935b5619e441dc8d8a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab52d3a01427d0e8bd52460d992144f65"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__setup.html#gab52d3a01427d0e8bd52460d992144f65">isWebSetupRunning</a> (bool *isRunningPtr)</td></tr>
<tr class="memdesc:gab52d3a01427d0e8bd52460d992144f65"><td class="mdescLeft"> </td><td class="mdescRight">Return status of WiConnect WiFi module 'web setup' feature. <a href="group__api__network__setup.html#gab52d3a01427d0e8bd52460d992144f65">More...</a><br /></td></tr>
<tr class="separator:gab52d3a01427d0e8bd52460d992144f65"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac439d0af5a17da32d405e25dcba83d16"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#gac439d0af5a17da32d405e25dcba83d16">join</a> (const char *ssid=NULL, const char *password=NULL, const <a class="el" href="classwiconnect_1_1_callback.html">Callback</a> &completeHandler=<a class="el" href="classwiconnect_1_1_callback.html">Callback</a>())</td></tr>
<tr class="memdesc:gac439d0af5a17da32d405e25dcba83d16"><td class="mdescLeft"> </td><td class="mdescRight">Join a WiFi network. <a href="group__api__network__wlan.html#gac439d0af5a17da32d405e25dcba83d16">More...</a><br /></td></tr>
<tr class="separator:gac439d0af5a17da32d405e25dcba83d16"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga14dc0f4fa58a7ebb25b77fae22052328"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#ga14dc0f4fa58a7ebb25b77fae22052328">leave</a> ()</td></tr>
<tr class="memdesc:ga14dc0f4fa58a7ebb25b77fae22052328"><td class="mdescLeft"> </td><td class="mdescRight">Leave a WiFi network. <a href="group__api__network__wlan.html#ga14dc0f4fa58a7ebb25b77fae22052328">More...</a><br /></td></tr>
<tr class="separator:ga14dc0f4fa58a7ebb25b77fae22052328"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga047ba9670f60406466391cec5bdd28e5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#ga047ba9670f60406466391cec5bdd28e5">getNetworkStatus</a> (<a class="el" href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">NetworkStatus</a> *statusPtr)</td></tr>
<tr class="memdesc:ga047ba9670f60406466391cec5bdd28e5"><td class="mdescLeft"> </td><td class="mdescRight">Get connection status to WiFi network. <a href="group__api__network__wlan.html#ga047ba9670f60406466391cec5bdd28e5">More...</a><br /></td></tr>
<tr class="separator:ga047ba9670f60406466391cec5bdd28e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafefe6e679d7b48a7127d3ed6371fe58b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#gafefe6e679d7b48a7127d3ed6371fe58b">getNetworkJoinResult</a> (<a class="el" href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">NetworkJoinResult</a> *joinResultPtr)</td></tr>
<tr class="memdesc:gafefe6e679d7b48a7127d3ed6371fe58b"><td class="mdescLeft"> </td><td class="mdescRight">Get the result of joining the network. <a href="group__api__network__wlan.html#gafefe6e679d7b48a7127d3ed6371fe58b">More...</a><br /></td></tr>
<tr class="separator:gafefe6e679d7b48a7127d3ed6371fe58b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaba16b9918e55c08285cf5b8b50dbabea"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaba16b9918e55c08285cf5b8b50dbabea"></a>
<a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#gaba16b9918e55c08285cf5b8b50dbabea">getSignalStrength</a> (<a class="el" href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a> *signalStrengthPtr)</td></tr>
<tr class="memdesc:gaba16b9918e55c08285cf5b8b50dbabea"><td class="mdescLeft"> </td><td class="mdescRight">Get <a class="el" href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a> of WiFi network module is connected. <br /></td></tr>
<tr class="separator:gaba16b9918e55c08285cf5b8b50dbabea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa9db3c463cf6b4f351c37671882dd3ee"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa9db3c463cf6b4f351c37671882dd3ee"></a>
<a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#gaa9db3c463cf6b4f351c37671882dd3ee">getRssi</a> (int32_t *rssiPtr)</td></tr>
<tr class="memdesc:gaa9db3c463cf6b4f351c37671882dd3ee"><td class="mdescLeft"> </td><td class="mdescRight">Get the RSSI in dBm of WiFi network. <br /></td></tr>
<tr class="separator:gaa9db3c463cf6b4f351c37671882dd3ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga70991a2c5865c8f0b44b67de35f3b6b3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga70991a2c5865c8f0b44b67de35f3b6b3"></a>
<a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#ga70991a2c5865c8f0b44b67de35f3b6b3">getMacAddress</a> (<a class="el" href="structwiconnect_1_1_mac_address.html">MacAddress</a> *macAddress)</td></tr>
<tr class="memdesc:ga70991a2c5865c8f0b44b67de35f3b6b3"><td class="mdescLeft"> </td><td class="mdescRight">Get MAC address of the WiFi module. <br /></td></tr>
<tr class="separator:ga70991a2c5865c8f0b44b67de35f3b6b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacdf014d8aca9de33dbc1563c6bb1f956"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__util.html#gacdf014d8aca9de33dbc1563c6bb1f956">scan</a> (<a class="el" href="classwiconnect_1_1_scan_result_list.html">ScanResultList</a> &resultList, const uint8_t *channelList=NULL, const char *ssid=NULL)</td></tr>
<tr class="memdesc:gacdf014d8aca9de33dbc1563c6bb1f956"><td class="mdescLeft"> </td><td class="mdescRight">Scan for available WiFi networks. <a href="group__api__network__util.html#gacdf014d8aca9de33dbc1563c6bb1f956">More...</a><br /></td></tr>
<tr class="separator:gacdf014d8aca9de33dbc1563c6bb1f956"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1da909dadb6f0e90218927ed350f72bc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__util.html#ga1da909dadb6f0e90218927ed350f72bc">ping</a> (const char *domain=NULL, uint32_t *timeMsPtr=NULL)</td></tr>
<tr class="memdesc:ga1da909dadb6f0e90218927ed350f72bc"><td class="mdescLeft"> </td><td class="mdescRight">Ping a WiFi network. <a href="group__api__network__util.html#ga1da909dadb6f0e90218927ed350f72bc">More...</a><br /></td></tr>
<tr class="separator:ga1da909dadb6f0e90218927ed350f72bc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1770babfc2abc6da7c085ef92709ee89"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__util.html#ga1770babfc2abc6da7c085ef92709ee89">lookup</a> (const char *domain, uint32_t *ipAddressPtr)</td></tr>
<tr class="memdesc:ga1770babfc2abc6da7c085ef92709ee89"><td class="mdescLeft"> </td><td class="mdescRight">Resolve domain name into IP address. <a href="group__api__network__util.html#ga1770babfc2abc6da7c085ef92709ee89">More...</a><br /></td></tr>
<tr class="separator:ga1770babfc2abc6da7c085ef92709ee89"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga65eb99f880ed739d0f3cd393e5b56eaf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#ga65eb99f880ed739d0f3cd393e5b56eaf">setDhcpEnabled</a> (bool enabled)</td></tr>
<tr class="memdesc:ga65eb99f880ed739d0f3cd393e5b56eaf"><td class="mdescLeft"> </td><td class="mdescRight">Set DHCP enabled. <a href="group__api__network__settings.html#ga65eb99f880ed739d0f3cd393e5b56eaf">More...</a><br /></td></tr>
<tr class="separator:ga65eb99f880ed739d0f3cd393e5b56eaf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga70ec796b88eb6f8e7990dbf3eb2f2eff"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga70ec796b88eb6f8e7990dbf3eb2f2eff"></a>
<a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#ga70ec796b88eb6f8e7990dbf3eb2f2eff">getDhcpEnabled</a> (bool *enabledPtr)</td></tr>
<tr class="memdesc:ga70ec796b88eb6f8e7990dbf3eb2f2eff"><td class="mdescLeft"> </td><td class="mdescRight">Get if DHCP enabled. <br /></td></tr>
<tr class="separator:ga70ec796b88eb6f8e7990dbf3eb2f2eff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2f7ec21084d3f2835d9c1c201915a9e0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2f7ec21084d3f2835d9c1c201915a9e0"></a>
<a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#ga2f7ec21084d3f2835d9c1c201915a9e0">setIpSettings</a> (uint32_t ip, uint32_t netmask, uint32_t gateway)</td></tr>
<tr class="memdesc:ga2f7ec21084d3f2835d9c1c201915a9e0"><td class="mdescLeft"> </td><td class="mdescRight">Set static IP settings. <br /></td></tr>
<tr class="separator:ga2f7ec21084d3f2835d9c1c201915a9e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa418175dd3d06b870f3dd8e035cb4dd0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa418175dd3d06b870f3dd8e035cb4dd0"></a>
<a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#gaa418175dd3d06b870f3dd8e035cb4dd0">setIpSettings</a> (const char *ip, const char *netmask, const char *gateway)</td></tr>
<tr class="memdesc:gaa418175dd3d06b870f3dd8e035cb4dd0"><td class="mdescLeft"> </td><td class="mdescRight">Set static IP settings (with string parameters) <br /></td></tr>
<tr class="separator:gaa418175dd3d06b870f3dd8e035cb4dd0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga291aef702f1c10bf2970394e3458022b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga291aef702f1c10bf2970394e3458022b"></a>
<a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#ga291aef702f1c10bf2970394e3458022b">getIpSettings</a> (uint32_t *ip, uint32_t *netmask, uint32_t *gateway)</td></tr>
<tr class="memdesc:ga291aef702f1c10bf2970394e3458022b"><td class="mdescLeft"> </td><td class="mdescRight">Get network IP settings. <br /></td></tr>
<tr class="separator:ga291aef702f1c10bf2970394e3458022b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga258d8b80064c6ce311a433affe63a0e9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga258d8b80064c6ce311a433affe63a0e9"></a>
<a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#ga258d8b80064c6ce311a433affe63a0e9">setDnsAddress</a> (uint32_t dnsAddress)</td></tr>
<tr class="memdesc:ga258d8b80064c6ce311a433affe63a0e9"><td class="mdescLeft"> </td><td class="mdescRight">Set static DNS Address. <br /></td></tr>
<tr class="separator:ga258d8b80064c6ce311a433affe63a0e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga585cb71d386ee61db3772f4b3218cb6e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga585cb71d386ee61db3772f4b3218cb6e"></a>
<a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#ga585cb71d386ee61db3772f4b3218cb6e">getDnsAddress</a> (uint32_t *dnsAddress)</td></tr>
<tr class="memdesc:ga585cb71d386ee61db3772f4b3218cb6e"><td class="mdescLeft"> </td><td class="mdescRight">Get the static DNS address. <br /></td></tr>
<tr class="separator:ga585cb71d386ee61db3772f4b3218cb6e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0b8fc3d5be0bae9ffcdc1b4b9aee6290"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#ga0b8fc3d5be0bae9ffcdc1b4b9aee6290">getIpAddress</a> (char *buffer=NULL)</td></tr>
<tr class="memdesc:ga0b8fc3d5be0bae9ffcdc1b4b9aee6290"><td class="mdescLeft"> </td><td class="mdescRight">Return the current IP address of the module if possible, else return 0.0.0.0. <a href="group__api__network__settings.html#ga0b8fc3d5be0bae9ffcdc1b4b9aee6290">More...</a><br /></td></tr>
<tr class="separator:ga0b8fc3d5be0bae9ffcdc1b4b9aee6290"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ga93bdb8669a70adaa61dc76073ce66591"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga93bdb8669a70adaa61dc76073ce66591"></a>
static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga93bdb8669a70adaa61dc76073ce66591">strToIp</a> (const char *str, uint32_t *intPtr)</td></tr>
<tr class="memdesc:ga93bdb8669a70adaa61dc76073ce66591"><td class="mdescLeft"> </td><td class="mdescRight">Convert string to IP address. <br /></td></tr>
<tr class="separator:ga93bdb8669a70adaa61dc76073ce66591"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaff8b0af70f4d4be792b943ad3af27303"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaff8b0af70f4d4be792b943ad3af27303"></a>
static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#gaff8b0af70f4d4be792b943ad3af27303">ipToStr</a> (uint32_t ip, char *ipStrBuffer=NULL)</td></tr>
<tr class="memdesc:gaff8b0af70f4d4be792b943ad3af27303"><td class="mdescLeft"> </td><td class="mdescRight">Convert IP address to string. <br /></td></tr>
<tr class="separator:gaff8b0af70f4d4be792b943ad3af27303"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacff5a4927d79e8b4c0d5a3050f5950b0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gacff5a4927d79e8b4c0d5a3050f5950b0"></a>
static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#gacff5a4927d79e8b4c0d5a3050f5950b0">networkStatusToStr</a> (<a class="el" href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">NetworkStatus</a> status)</td></tr>
<tr class="memdesc:gacff5a4927d79e8b4c0d5a3050f5950b0"><td class="mdescLeft"> </td><td class="mdescRight">Convert <a class="el" href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">NetworkStatus</a> to string. <br /></td></tr>
<tr class="separator:gacff5a4927d79e8b4c0d5a3050f5950b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5a682e671900b9b7f931137deb847fa6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5a682e671900b9b7f931137deb847fa6"></a>
static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga5a682e671900b9b7f931137deb847fa6">networkJoinResultToStr</a> (<a class="el" href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">NetworkJoinResult</a> joinResult)</td></tr>
<tr class="memdesc:ga5a682e671900b9b7f931137deb847fa6"><td class="mdescLeft"> </td><td class="mdescRight">Convert <a class="el" href="group__api__network__types.html#ga5f6f5c916a5dd1676f98da7fa511451d">NetworkJoinResult</a> to string. <br /></td></tr>
<tr class="separator:ga5a682e671900b9b7f931137deb847fa6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad4661f859cfadbe193793898671043c9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad4661f859cfadbe193793898671043c9"></a>
static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#gad4661f859cfadbe193793898671043c9">signalStrengthToStr</a> (<a class="el" href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a> signalStrenth)</td></tr>
<tr class="memdesc:gad4661f859cfadbe193793898671043c9"><td class="mdescLeft"> </td><td class="mdescRight">Convert <a class="el" href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a> to string. <br /></td></tr>
<tr class="separator:gad4661f859cfadbe193793898671043c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6216eed4cc05c37ce1ed13a0fbb6acd8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6216eed4cc05c37ce1ed13a0fbb6acd8"></a>
static <a class="el" href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga6216eed4cc05c37ce1ed13a0fbb6acd8">rssiToSignalStrength</a> (int rssi)</td></tr>
<tr class="memdesc:ga6216eed4cc05c37ce1ed13a0fbb6acd8"><td class="mdescLeft"> </td><td class="mdescRight">Convert RSSI (in dBm) to <a class="el" href="group__api__network__types.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a>. <br /></td></tr>
<tr class="separator:ga6216eed4cc05c37ce1ed13a0fbb6acd8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad7d49be19f9ca91bc129668dd50d9e57"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad7d49be19f9ca91bc129668dd50d9e57"></a>
static <a class="el" href="group__api__network__types.html#ga026bd11cd5df47b7022362243e2d553f">NetworkSecurity</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#gad7d49be19f9ca91bc129668dd50d9e57">strToNetworkSecurity</a> (const char *str)</td></tr>
<tr class="memdesc:gad7d49be19f9ca91bc129668dd50d9e57"><td class="mdescLeft"> </td><td class="mdescRight">Convert string to <a class="el" href="group__api__network__types.html#ga026bd11cd5df47b7022362243e2d553f">NetworkSecurity</a>. <br /></td></tr>
<tr class="separator:gad7d49be19f9ca91bc129668dd50d9e57"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae02c549079cfb0350117cd6343a3d66f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae02c549079cfb0350117cd6343a3d66f"></a>
static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#gae02c549079cfb0350117cd6343a3d66f">networkSecurityToStr</a> (<a class="el" href="group__api__network__types.html#ga026bd11cd5df47b7022362243e2d553f">NetworkSecurity</a> security)</td></tr>
<tr class="memdesc:gae02c549079cfb0350117cd6343a3d66f"><td class="mdescLeft"> </td><td class="mdescRight">Convert <a class="el" href="group__api__network__types.html#ga026bd11cd5df47b7022362243e2d553f">NetworkSecurity</a> to string. <br /></td></tr>
<tr class="separator:gae02c549079cfb0350117cd6343a3d66f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6a479a58591ead92dcf0586e11fcad17"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6a479a58591ead92dcf0586e11fcad17"></a>
static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga6a479a58591ead92dcf0586e11fcad17">strToSsid</a> (const char *str, <a class="el" href="structwiconnect_1_1_ssid.html">Ssid</a> *ssid)</td></tr>
<tr class="memdesc:ga6a479a58591ead92dcf0586e11fcad17"><td class="mdescLeft"> </td><td class="mdescRight">Convert string <a class="el" href="structwiconnect_1_1_ssid.html">Ssid</a>. <br /></td></tr>
<tr class="separator:ga6a479a58591ead92dcf0586e11fcad17"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafce7929a10e16cf9be7307a2f97bef3f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gafce7929a10e16cf9be7307a2f97bef3f"></a>
static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#gafce7929a10e16cf9be7307a2f97bef3f">ssidToStr</a> (const <a class="el" href="structwiconnect_1_1_ssid.html">Ssid</a> *ssid, char *ssidStrBuffer=NULL)</td></tr>
<tr class="memdesc:gafce7929a10e16cf9be7307a2f97bef3f"><td class="mdescLeft"> </td><td class="mdescRight">Convert <a class="el" href="structwiconnect_1_1_ssid.html">Ssid</a> to string. <br /></td></tr>
<tr class="separator:gafce7929a10e16cf9be7307a2f97bef3f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga347f05073370d6872a5cdac74de39b1b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga347f05073370d6872a5cdac74de39b1b"></a>
static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga347f05073370d6872a5cdac74de39b1b">strToMacAddress</a> (const char *str, <a class="el" href="structwiconnect_1_1_mac_address.html">MacAddress</a> *macAddress)</td></tr>
<tr class="memdesc:ga347f05073370d6872a5cdac74de39b1b"><td class="mdescLeft"> </td><td class="mdescRight">Convert string <a class="el" href="structwiconnect_1_1_mac_address.html">MacAddress</a>. <br /></td></tr>
<tr class="separator:ga347f05073370d6872a5cdac74de39b1b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga13ecaf390b4bf4a68b51a6b18e669134"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga13ecaf390b4bf4a68b51a6b18e669134"></a>
static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga13ecaf390b4bf4a68b51a6b18e669134">macAddressToStr</a> (const <a class="el" href="structwiconnect_1_1_mac_address.html">MacAddress</a> *macAddress, char *macStrBuffer=NULL)</td></tr>
<tr class="memdesc:ga13ecaf390b4bf4a68b51a6b18e669134"><td class="mdescLeft"> </td><td class="mdescRight">Convert <a class="el" href="structwiconnect_1_1_mac_address.html">MacAddress</a> to string. <br /></td></tr>
<tr class="separator:ga13ecaf390b4bf4a68b51a6b18e669134"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>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. </p>
<dl class="section note"><dt>Note</dt><dd>This class is an interface to the <a class="el" href="classwiconnect_1_1_wiconnect.html" title="The root WiConnect library class. This class inheriets all WiConnect functionality. ">Wiconnect</a> class. It should never be independently instantiated or the parent of another class. </dd></dl>
<p>Definition at line <a class="el" href="_network_interface_8h_source.html#l00055">55</a> of file <a class="el" href="_network_interface_8h_source.html">NetworkInterface.h</a>.</p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>C:/Users/reed/workspace/host-wiconnect/src/wiconnect/Wiconnect/api/<a class="el" href="_network_interface_8h_source.html">NetworkInterface.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">© ACKme Networks 2014</li>
</ul>
</div>
</body>
</html>
Repository toolbox
| Export to desktop IDE |
Repository details
| Type: | Library |
|---|---|
| Created: | 11 Aug 2014 |
| Imports: | 190 |
| Forks: | 0 |
| Commits: | 43 |
| Dependents: | 10 |
| Dependencies: | 0 |
| Followers: | 25 |
Components
AMW006-A02