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
Child:
13:2b51f5267c92
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: wiconnect::NetworkInterface Class Reference</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 class="current"><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 id="navrow2" class="tabs2">
dan_ackme 11:ea484e1b7fc4 69 <ul class="tablist">
dan_ackme 11:ea484e1b7fc4 70 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
dan_ackme 11:ea484e1b7fc4 71 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
dan_ackme 11:ea484e1b7fc4 72 <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
dan_ackme 11:ea484e1b7fc4 73 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
dan_ackme 11:ea484e1b7fc4 74 </ul>
dan_ackme 11:ea484e1b7fc4 75 </div>
dan_ackme 11:ea484e1b7fc4 76 </div><!-- top -->
dan_ackme 11:ea484e1b7fc4 77 <div id="side-nav" class="ui-resizable side-nav-resizable">
dan_ackme 11:ea484e1b7fc4 78 <div id="nav-tree">
dan_ackme 11:ea484e1b7fc4 79 <div id="nav-tree-contents">
dan_ackme 11:ea484e1b7fc4 80 <div id="nav-sync" class="sync"></div>
dan_ackme 11:ea484e1b7fc4 81 </div>
dan_ackme 11:ea484e1b7fc4 82 </div>
dan_ackme 11:ea484e1b7fc4 83 <div id="splitbar" style="-moz-user-select:none;"
dan_ackme 11:ea484e1b7fc4 84 class="ui-resizable-handle">
dan_ackme 11:ea484e1b7fc4 85 </div>
dan_ackme 11:ea484e1b7fc4 86 </div>
dan_ackme 11:ea484e1b7fc4 87 <script type="text/javascript">
dan_ackme 11:ea484e1b7fc4 88 $(document).ready(function(){initNavTree('classwiconnect_1_1_network_interface.html','');});
dan_ackme 11:ea484e1b7fc4 89 </script>
dan_ackme 11:ea484e1b7fc4 90 <div id="doc-content">
dan_ackme 11:ea484e1b7fc4 91 <!-- window showing the filter options -->
dan_ackme 11:ea484e1b7fc4 92 <div id="MSearchSelectWindow"
dan_ackme 11:ea484e1b7fc4 93 onmouseover="return searchBox.OnSearchSelectShow()"
dan_ackme 11:ea484e1b7fc4 94 onmouseout="return searchBox.OnSearchSelectHide()"
dan_ackme 11:ea484e1b7fc4 95 onkeydown="return searchBox.OnSearchSelectKey(event)">
dan_ackme 11:ea484e1b7fc4 96 <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 97
dan_ackme 11:ea484e1b7fc4 98 <!-- iframe showing the search results (closed by default) -->
dan_ackme 11:ea484e1b7fc4 99 <div id="MSearchResultsWindow">
dan_ackme 11:ea484e1b7fc4 100 <iframe src="javascript:void(0)" frameborder="0"
dan_ackme 11:ea484e1b7fc4 101 name="MSearchResults" id="MSearchResults">
dan_ackme 11:ea484e1b7fc4 102 </iframe>
dan_ackme 11:ea484e1b7fc4 103 </div>
dan_ackme 11:ea484e1b7fc4 104
dan_ackme 11:ea484e1b7fc4 105 <div class="header">
dan_ackme 11:ea484e1b7fc4 106 <div class="summary">
dan_ackme 11:ea484e1b7fc4 107 <a href="#pub-methods">Public Member Functions</a> &#124;
dan_ackme 11:ea484e1b7fc4 108 <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
dan_ackme 11:ea484e1b7fc4 109 <a href="classwiconnect_1_1_network_interface-members.html">List of all members</a> </div>
dan_ackme 11:ea484e1b7fc4 110 <div class="headertitle">
dan_ackme 11:ea484e1b7fc4 111 <div class="title">wiconnect::NetworkInterface Class Reference<div class="ingroups"><a class="el" href="group__types__network.html">Network API</a></div></div> </div>
dan_ackme 11:ea484e1b7fc4 112 </div><!--header-->
dan_ackme 11:ea484e1b7fc4 113 <div class="contents">
dan_ackme 11:ea484e1b7fc4 114
dan_ackme 11:ea484e1b7fc4 115 <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.
dan_ackme 11:ea484e1b7fc4 116 <a href="classwiconnect_1_1_network_interface.html#details">More...</a></p>
dan_ackme 11:ea484e1b7fc4 117
dan_ackme 11:ea484e1b7fc4 118 <p><code>#include &lt;NetworkInterface.h&gt;</code></p>
dan_ackme 11:ea484e1b7fc4 119
dan_ackme 11:ea484e1b7fc4 120 <p>Inherited by <a class="el" href="classwiconnect_1_1_wiconnect.html">wiconnect::Wiconnect</a>.</p>
dan_ackme 11:ea484e1b7fc4 121 <table class="memberdecls">
dan_ackme 11:ea484e1b7fc4 122 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
dan_ackme 11:ea484e1b7fc4 123 Public Member Functions</h2></td></tr>
dan_ackme 11:ea484e1b7fc4 124 <tr class="memitem:gaea3e133f2ee8c95d8d108c15561f3847"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaea3e133f2ee8c95d8d108c15561f3847"></a>
dan_ackme 11:ea484e1b7fc4 125 <a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</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> &amp;completeHandler=<a class="el" href="classwiconnect_1_1_callback.html">Callback</a>())</td></tr>
dan_ackme 11:ea484e1b7fc4 126 <tr class="memdesc:gaea3e133f2ee8c95d8d108c15561f3847"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the WiConnect WiFi module 'web setup' feature. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 127 <tr class="separator:gaea3e133f2ee8c95d8d108c15561f3847"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 128 <tr class="memitem:gac5ca67b7bfa587935b5619e441dc8d8a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac5ca67b7bfa587935b5619e441dc8d8a"></a>
dan_ackme 11:ea484e1b7fc4 129 <a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__setup.html#gac5ca67b7bfa587935b5619e441dc8d8a">stopWebSetup</a> ()</td></tr>
dan_ackme 11:ea484e1b7fc4 130 <tr class="memdesc:gac5ca67b7bfa587935b5619e441dc8d8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop the WiConnect WiFi module 'web setup' feature. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 131 <tr class="separator:gac5ca67b7bfa587935b5619e441dc8d8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 132 <tr class="memitem:gab52d3a01427d0e8bd52460d992144f65"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab52d3a01427d0e8bd52460d992144f65"></a>
dan_ackme 11:ea484e1b7fc4 133 <a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__setup.html#gab52d3a01427d0e8bd52460d992144f65">isWebSetupRunning</a> (bool *isRunningPtr)</td></tr>
dan_ackme 11:ea484e1b7fc4 134 <tr class="memdesc:gab52d3a01427d0e8bd52460d992144f65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return status of WiConnect WiFi module 'web setup' feature. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 135 <tr class="separator:gab52d3a01427d0e8bd52460d992144f65"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 136 <tr class="memitem:gac439d0af5a17da32d405e25dcba83d16"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac439d0af5a17da32d405e25dcba83d16"></a>
dan_ackme 11:ea484e1b7fc4 137 <a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</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> &amp;completeHandler=<a class="el" href="classwiconnect_1_1_callback.html">Callback</a>())</td></tr>
dan_ackme 11:ea484e1b7fc4 138 <tr class="memdesc:gac439d0af5a17da32d405e25dcba83d16"><td class="mdescLeft">&#160;</td><td class="mdescRight">Join a WiFi network. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 139 <tr class="separator:gac439d0af5a17da32d405e25dcba83d16"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 140 <tr class="memitem:ga14dc0f4fa58a7ebb25b77fae22052328"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga14dc0f4fa58a7ebb25b77fae22052328"></a>
dan_ackme 11:ea484e1b7fc4 141 <a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#ga14dc0f4fa58a7ebb25b77fae22052328">leave</a> ()</td></tr>
dan_ackme 11:ea484e1b7fc4 142 <tr class="memdesc:ga14dc0f4fa58a7ebb25b77fae22052328"><td class="mdescLeft">&#160;</td><td class="mdescRight">Leave a WiFi network. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 143 <tr class="separator:ga14dc0f4fa58a7ebb25b77fae22052328"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 144 <tr class="memitem:ga047ba9670f60406466391cec5bdd28e5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga047ba9670f60406466391cec5bdd28e5"></a>
dan_ackme 11:ea484e1b7fc4 145 <a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__wlan.html#ga047ba9670f60406466391cec5bdd28e5">getNetworkStatus</a> (<a class="el" href="group__types__network.html#gab448e57fc1a5e21cbba0283fd1a35d99">NetworkStatus</a> *statusPtr)</td></tr>
dan_ackme 11:ea484e1b7fc4 146 <tr class="memdesc:ga047ba9670f60406466391cec5bdd28e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get connection status to WiFi network. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 147 <tr class="separator:ga047ba9670f60406466391cec5bdd28e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 148 <tr class="memitem:gacdf014d8aca9de33dbc1563c6bb1f956"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gacdf014d8aca9de33dbc1563c6bb1f956"></a>
dan_ackme 11:ea484e1b7fc4 149 <a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</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> &amp;resultList, const uint8_t *channelList=NULL, const char *ssid=NULL)</td></tr>
dan_ackme 11:ea484e1b7fc4 150 <tr class="memdesc:gacdf014d8aca9de33dbc1563c6bb1f956"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scan for available WiFi networks. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 151 <tr class="separator:gacdf014d8aca9de33dbc1563c6bb1f956"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 152 <tr class="memitem:ga1da909dadb6f0e90218927ed350f72bc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1da909dadb6f0e90218927ed350f72bc"></a>
dan_ackme 11:ea484e1b7fc4 153 <a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</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>
dan_ackme 11:ea484e1b7fc4 154 <tr class="memdesc:ga1da909dadb6f0e90218927ed350f72bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ping a WiFi network. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 155 <tr class="separator:ga1da909dadb6f0e90218927ed350f72bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 156 <tr class="memitem:ga1770babfc2abc6da7c085ef92709ee89"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1770babfc2abc6da7c085ef92709ee89"></a>
dan_ackme 11:ea484e1b7fc4 157 <a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</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>
dan_ackme 11:ea484e1b7fc4 158 <tr class="memdesc:ga1770babfc2abc6da7c085ef92709ee89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resolve domain name into IP address. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 159 <tr class="separator:ga1770babfc2abc6da7c085ef92709ee89"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 160 <tr class="memitem:ga65eb99f880ed739d0f3cd393e5b56eaf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga65eb99f880ed739d0f3cd393e5b56eaf"></a>
dan_ackme 11:ea484e1b7fc4 161 <a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#ga65eb99f880ed739d0f3cd393e5b56eaf">setDhcpEnabled</a> (bool enabled)</td></tr>
dan_ackme 11:ea484e1b7fc4 162 <tr class="memdesc:ga65eb99f880ed739d0f3cd393e5b56eaf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set DHCP enabled. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 163 <tr class="separator:ga65eb99f880ed739d0f3cd393e5b56eaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 164 <tr class="memitem:ga70ec796b88eb6f8e7990dbf3eb2f2eff"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga70ec796b88eb6f8e7990dbf3eb2f2eff"></a>
dan_ackme 11:ea484e1b7fc4 165 <a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#ga70ec796b88eb6f8e7990dbf3eb2f2eff">getDhcpEnabled</a> (bool *enabledPtr)</td></tr>
dan_ackme 11:ea484e1b7fc4 166 <tr class="memdesc:ga70ec796b88eb6f8e7990dbf3eb2f2eff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get if DHCP enabled. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 167 <tr class="separator:ga70ec796b88eb6f8e7990dbf3eb2f2eff"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 168 <tr class="memitem:ga2f7ec21084d3f2835d9c1c201915a9e0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2f7ec21084d3f2835d9c1c201915a9e0"></a>
dan_ackme 11:ea484e1b7fc4 169 <a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</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>
dan_ackme 11:ea484e1b7fc4 170 <tr class="memdesc:ga2f7ec21084d3f2835d9c1c201915a9e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set static IP settings. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 171 <tr class="separator:ga2f7ec21084d3f2835d9c1c201915a9e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 172 <tr class="memitem:gaa418175dd3d06b870f3dd8e035cb4dd0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa418175dd3d06b870f3dd8e035cb4dd0"></a>
dan_ackme 11:ea484e1b7fc4 173 <a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</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>
dan_ackme 11:ea484e1b7fc4 174 <tr class="memdesc:gaa418175dd3d06b870f3dd8e035cb4dd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set static IP settings (with string parameters) <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 175 <tr class="separator:gaa418175dd3d06b870f3dd8e035cb4dd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 176 <tr class="memitem:ga291aef702f1c10bf2970394e3458022b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga291aef702f1c10bf2970394e3458022b"></a>
dan_ackme 11:ea484e1b7fc4 177 <a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</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>
dan_ackme 11:ea484e1b7fc4 178 <tr class="memdesc:ga291aef702f1c10bf2970394e3458022b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get network IP settings. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 179 <tr class="separator:ga291aef702f1c10bf2970394e3458022b"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 180 <tr class="memitem:gaba16b9918e55c08285cf5b8b50dbabea"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaba16b9918e55c08285cf5b8b50dbabea"></a>
dan_ackme 11:ea484e1b7fc4 181 <a class="el" href="group__types__core.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#gaba16b9918e55c08285cf5b8b50dbabea">getSignalStrength</a> (<a class="el" href="group__types__network.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a> *signalStrengthPtr)</td></tr>
dan_ackme 11:ea484e1b7fc4 182 <tr class="memdesc:gaba16b9918e55c08285cf5b8b50dbabea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get signal strength to WiFi network. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 183 <tr class="separator:gaba16b9918e55c08285cf5b8b50dbabea"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 184 </table><table class="memberdecls">
dan_ackme 11:ea484e1b7fc4 185 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
dan_ackme 11:ea484e1b7fc4 186 Static Public Member Functions</h2></td></tr>
dan_ackme 11:ea484e1b7fc4 187 <tr class="memitem:ga93bdb8669a70adaa61dc76073ce66591"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga93bdb8669a70adaa61dc76073ce66591"></a>
dan_ackme 11:ea484e1b7fc4 188 static bool&#160;</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>
dan_ackme 11:ea484e1b7fc4 189 <tr class="memdesc:ga93bdb8669a70adaa61dc76073ce66591"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert string to IP address. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 190 <tr class="separator:ga93bdb8669a70adaa61dc76073ce66591"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 191 <tr class="memitem:gaff8b0af70f4d4be792b943ad3af27303"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaff8b0af70f4d4be792b943ad3af27303"></a>
dan_ackme 11:ea484e1b7fc4 192 static const char *&#160;</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>
dan_ackme 11:ea484e1b7fc4 193 <tr class="memdesc:gaff8b0af70f4d4be792b943ad3af27303"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert IP address to string. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 194 <tr class="separator:gaff8b0af70f4d4be792b943ad3af27303"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 195 <tr class="memitem:gacff5a4927d79e8b4c0d5a3050f5950b0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gacff5a4927d79e8b4c0d5a3050f5950b0"></a>
dan_ackme 11:ea484e1b7fc4 196 static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#gacff5a4927d79e8b4c0d5a3050f5950b0">networkStatusToStr</a> (<a class="el" href="group__types__network.html#gab448e57fc1a5e21cbba0283fd1a35d99">NetworkStatus</a> status)</td></tr>
dan_ackme 11:ea484e1b7fc4 197 <tr class="memdesc:gacff5a4927d79e8b4c0d5a3050f5950b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert <a class="el" href="group__types__network.html#gab448e57fc1a5e21cbba0283fd1a35d99">NetworkStatus</a> to string. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 198 <tr class="separator:gacff5a4927d79e8b4c0d5a3050f5950b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 199 <tr class="memitem:gad4661f859cfadbe193793898671043c9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad4661f859cfadbe193793898671043c9"></a>
dan_ackme 11:ea484e1b7fc4 200 static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#gad4661f859cfadbe193793898671043c9">signalStrengthToStr</a> (<a class="el" href="group__types__network.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a> signalStrenth)</td></tr>
dan_ackme 11:ea484e1b7fc4 201 <tr class="memdesc:gad4661f859cfadbe193793898671043c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert <a class="el" href="group__types__network.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a> to string. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 202 <tr class="separator:gad4661f859cfadbe193793898671043c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 203 <tr class="memitem:ga6216eed4cc05c37ce1ed13a0fbb6acd8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6216eed4cc05c37ce1ed13a0fbb6acd8"></a>
dan_ackme 11:ea484e1b7fc4 204 static <a class="el" href="group__types__network.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga6216eed4cc05c37ce1ed13a0fbb6acd8">rssiToSignalStrength</a> (int rssi)</td></tr>
dan_ackme 11:ea484e1b7fc4 205 <tr class="memdesc:ga6216eed4cc05c37ce1ed13a0fbb6acd8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert RSSI (in dBm) to <a class="el" href="group__types__network.html#gac5aead2b4cca0122a60168e75ea41d36">NetworkSignalStrength</a>. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 206 <tr class="separator:ga6216eed4cc05c37ce1ed13a0fbb6acd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 207 <tr class="memitem:gad7d49be19f9ca91bc129668dd50d9e57"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad7d49be19f9ca91bc129668dd50d9e57"></a>
dan_ackme 11:ea484e1b7fc4 208 static <a class="el" href="group__types__network.html#ga026bd11cd5df47b7022362243e2d553f">NetworkSecurity</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#gad7d49be19f9ca91bc129668dd50d9e57">strToNetworkSecurity</a> (const char *str)</td></tr>
dan_ackme 11:ea484e1b7fc4 209 <tr class="memdesc:gad7d49be19f9ca91bc129668dd50d9e57"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert string to <a class="el" href="group__types__network.html#ga026bd11cd5df47b7022362243e2d553f">NetworkSecurity</a>. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 210 <tr class="separator:gad7d49be19f9ca91bc129668dd50d9e57"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 211 <tr class="memitem:gae02c549079cfb0350117cd6343a3d66f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae02c549079cfb0350117cd6343a3d66f"></a>
dan_ackme 11:ea484e1b7fc4 212 static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#gae02c549079cfb0350117cd6343a3d66f">networkSecurityToStr</a> (<a class="el" href="group__types__network.html#ga026bd11cd5df47b7022362243e2d553f">NetworkSecurity</a> security)</td></tr>
dan_ackme 11:ea484e1b7fc4 213 <tr class="memdesc:gae02c549079cfb0350117cd6343a3d66f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert <a class="el" href="group__types__network.html#ga026bd11cd5df47b7022362243e2d553f">NetworkSecurity</a> to string. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 214 <tr class="separator:gae02c549079cfb0350117cd6343a3d66f"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 215 <tr class="memitem:ga6a479a58591ead92dcf0586e11fcad17"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6a479a58591ead92dcf0586e11fcad17"></a>
dan_ackme 11:ea484e1b7fc4 216 static bool&#160;</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>
dan_ackme 11:ea484e1b7fc4 217 <tr class="memdesc:ga6a479a58591ead92dcf0586e11fcad17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert string <a class="el" href="structwiconnect_1_1_ssid.html">Ssid</a>. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 218 <tr class="separator:ga6a479a58591ead92dcf0586e11fcad17"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 219 <tr class="memitem:gafce7929a10e16cf9be7307a2f97bef3f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gafce7929a10e16cf9be7307a2f97bef3f"></a>
dan_ackme 11:ea484e1b7fc4 220 static const char *&#160;</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>
dan_ackme 11:ea484e1b7fc4 221 <tr class="memdesc:gafce7929a10e16cf9be7307a2f97bef3f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert <a class="el" href="structwiconnect_1_1_ssid.html">Ssid</a> to string. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 222 <tr class="separator:gafce7929a10e16cf9be7307a2f97bef3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 223 <tr class="memitem:ga347f05073370d6872a5cdac74de39b1b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga347f05073370d6872a5cdac74de39b1b"></a>
dan_ackme 11:ea484e1b7fc4 224 static bool&#160;</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>
dan_ackme 11:ea484e1b7fc4 225 <tr class="memdesc:ga347f05073370d6872a5cdac74de39b1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert string <a class="el" href="structwiconnect_1_1_mac_address.html">MacAddress</a>. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 226 <tr class="separator:ga347f05073370d6872a5cdac74de39b1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 227 <tr class="memitem:ga13ecaf390b4bf4a68b51a6b18e669134"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga13ecaf390b4bf4a68b51a6b18e669134"></a>
dan_ackme 11:ea484e1b7fc4 228 static const char *&#160;</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>
dan_ackme 11:ea484e1b7fc4 229 <tr class="memdesc:ga13ecaf390b4bf4a68b51a6b18e669134"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert <a class="el" href="structwiconnect_1_1_mac_address.html">MacAddress</a> to string. <br /></td></tr>
dan_ackme 11:ea484e1b7fc4 230 <tr class="separator:ga13ecaf390b4bf4a68b51a6b18e669134"><td class="memSeparator" colspan="2">&#160;</td></tr>
dan_ackme 11:ea484e1b7fc4 231 </table>
dan_ackme 11:ea484e1b7fc4 232 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
dan_ackme 11:ea484e1b7fc4 233 <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>
dan_ackme 11:ea484e1b7fc4 234 </div><hr/>The documentation for this class was generated from the following file:<ul>
dan_ackme 11:ea484e1b7fc4 235 <li>C:/Users/reed/workspace/host-wiconnect/src/wiconnect/Wiconnect/NetworkInterface.h</li>
dan_ackme 11:ea484e1b7fc4 236 </ul>
dan_ackme 11:ea484e1b7fc4 237 </div><!-- contents -->
dan_ackme 11:ea484e1b7fc4 238 </div><!-- doc-content -->
dan_ackme 11:ea484e1b7fc4 239 <!-- start footer part -->
dan_ackme 11:ea484e1b7fc4 240 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
dan_ackme 11:ea484e1b7fc4 241 <ul>
dan_ackme 11:ea484e1b7fc4 242 <li class="navelem"><a class="el" href="namespacewiconnect.html">wiconnect</a></li><li class="navelem"><a class="el" href="classwiconnect_1_1_network_interface.html">NetworkInterface</a></li>
dan_ackme 11:ea484e1b7fc4 243 <li class="footer">Generated on Tue Aug 12 2014 02:15:24 for WiConnect Library by
dan_ackme 11:ea484e1b7fc4 244 <a href="http://www.doxygen.org/index.html">
dan_ackme 11:ea484e1b7fc4 245 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
dan_ackme 11:ea484e1b7fc4 246 </ul>
dan_ackme 11:ea484e1b7fc4 247 </div>
dan_ackme 11:ea484e1b7fc4 248 </body>
dan_ackme 11:ea484e1b7fc4 249 </html>