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__api__network__util.html
- Revision:
- 13:2b51f5267c92
- Parent:
- 11:ea484e1b7fc4
- Child:
- 26:8067e3d463d3
--- a/doc/html/group__api__network__util.html Tue Aug 12 02:44:34 2014 -0700 +++ b/doc/html/group__api__network__util.html Wed Aug 13 03:14:30 2014 -0700 @@ -3,8 +3,9 @@ <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: Utilities</title> +<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> @@ -24,29 +25,30 @@ </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 --> +<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>Main 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="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><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="http://wiconnect.ack.me/1.2/general_overview"><span>WiConnect Reference Manual</span></a></li> + <li><a href="http://www.ack.me/WiConnect"><span>ACKme Website</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> @@ -98,39 +100,152 @@ <div class="summary"> <a href="#func-members">Functions</a> </div> <div class="headertitle"> -<div class="title">Utilities<div class="ingroups"><a class="el" href="group__api__network.html">Network API</a></div></div> </div> +<div class="title">Utility Methods<div class="ingroups"><a class="el" href="group__api__network.html">Network</a></div></div> </div> </div><!--header--> <div class="contents"> -<p>Network utility API methods. +<p>Network utility methods. <a href="#details">More...</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> -<tr class="memitem:gacdf014d8aca9de33dbc1563c6bb1f956"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gacdf014d8aca9de33dbc1563c6bb1f956"></a> -WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__util.html#gacdf014d8aca9de33dbc1563c6bb1f956">wiconnect::NetworkInterface::scan</a> (ScanResultList &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. <br /></td></tr> +<tr class="memitem:gacdf014d8aca9de33dbc1563c6bb1f956"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__util.html#gacdf014d8aca9de33dbc1563c6bb1f956">wiconnect::NetworkInterface::scan</a> (ScanResultList &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="#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="anchor" id="ga1da909dadb6f0e90218927ed350f72bc"></a> -WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__util.html#ga1da909dadb6f0e90218927ed350f72bc">wiconnect::NetworkInterface::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. <br /></td></tr> +<tr class="memitem:ga1da909dadb6f0e90218927ed350f72bc"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__util.html#ga1da909dadb6f0e90218927ed350f72bc">wiconnect::NetworkInterface::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="#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="anchor" id="ga1770babfc2abc6da7c085ef92709ee89"></a> -WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__util.html#ga1770babfc2abc6da7c085ef92709ee89">wiconnect::NetworkInterface::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. <br /></td></tr> +<tr class="memitem:ga1770babfc2abc6da7c085ef92709ee89"><td class="memItemLeft" align="right" valign="top">WiconnectResult </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__util.html#ga1770babfc2abc6da7c085ef92709ee89">wiconnect::NetworkInterface::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="#ga1770babfc2abc6da7c085ef92709ee89">More...</a><br /></td></tr> <tr class="separator:ga1770babfc2abc6da7c085ef92709ee89"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<p>Network utility API methods. </p> +<p>Network utility methods. </p> +<h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="ga1770babfc2abc6da7c085ef92709ee89"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">WiconnectResult wiconnect::NetworkInterface::lookup </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>domain</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t * </td> + <td class="paramname"><em>ipAddressPtr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Resolve domain name into IP address. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">domain</td><td>The domain name to resolve </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">ipAddressPtr</td><td>pointer to uint32 to hold resolved IP address. Note, the IP address is in network-byte-order. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="ga1da909dadb6f0e90218927ed350f72bc"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">WiconnectResult wiconnect::NetworkInterface::ping </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>domain</em> = <code>NULL</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t * </td> + <td class="paramname"><em>timeMsPtr</em> = <code>NULL</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Ping a WiFi network. </p> +<p>Optionally ping a specific server and return the time in milliseconds it took for the network to response. If no domain is supplied, the module pings to gateway (i.e router it's connected to).</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">domain</td><td>Optional, the domain name to ping </td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">timeMsPtr</td><td>Optional, pointer to uint32 to hold time in milliseconds the ping took </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl> + +</div> +</div> +<a class="anchor" id="gacdf014d8aca9de33dbc1563c6bb1f956"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">WiconnectResult wiconnect::NetworkInterface::scan </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classwiconnect_1_1_scan_result_list.html">ScanResultList</a> & </td> + <td class="paramname"><em>resultList</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const uint8_t * </td> + <td class="paramname"><em>channelList</em> = <code>NULL</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>ssid</em> = <code>NULL</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Scan for available WiFi networks. </p> +<p>The populate the supplied <a class="el" href="classwiconnect_1_1_scan_result_list.html">ScanResultList</a> with <a class="el" href="classwiconnect_1_1_scan_result.html">ScanResult</a> of each found network.</p> +<p>Optionally only scan of specific channels by supplying a null terminated list of channels. Example: </p><div class="fragment"><div class="line"><span class="keyword">const</span> uint8_t channelsToScan[] = {1, 6, 11, 0};</div> +</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[out]</td><td class="paramname">resultList</td><td>List to populate with scan results. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">channelList</td><td>Optional, null terminated list of channels to scan. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">ssid</td><td>Optional, specific network name to scan for. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Result of method. See <a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a> </dd></dl> + +</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> + <li class="footer">© ACKme Networks 2014</li> </ul> </div> </body> -</html> +</html> \ No newline at end of file