Diff: doc/html/classwiconnect_1_1_network_interface.html

Revision:

29:b6af04b77a56

Parent:

26:8067e3d463d3

--- a/doc/html/classwiconnect_1_1_network_interface.html	Mon Oct 27 13:32:40 2014 -0700
+++ b/doc/html/classwiconnect_1_1_network_interface.html	Mon Oct 27 13:42:26 2014 -0700
@@ -144,6 +144,18 @@
 <tr class="memitem:gafefe6e679d7b48a7127d3ed6371fe58b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__core__types.html#ga325637ed501728bd6c8c7a7982b9ce05">WiconnectResult</a>&#160;</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">&#160;</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">&#160;</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>&#160;</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">&#160;</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">&#160;</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>&#160;</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">&#160;</td><td class="mdescRight">Get the RSSI in dBm of WiFi network. <br /></td></tr>
+<tr class="separator:gaa9db3c463cf6b4f351c37671882dd3ee"><td class="memSeparator" colspan="2">&#160;</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>&#160;</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">&#160;</td><td class="mdescRight">Get MAC address of the WiFi module. <br /></td></tr>
+<tr class="separator:ga70991a2c5865c8f0b44b67de35f3b6b3"><td class="memSeparator" colspan="2">&#160;</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>&#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>
 <tr class="memdesc:gacdf014d8aca9de33dbc1563c6bb1f956"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
@@ -172,13 +184,17 @@
 <a class="el" href="group__api__core__types.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>
 <tr class="memdesc:ga291aef702f1c10bf2970394e3458022b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get network IP settings. <br /></td></tr>
 <tr class="separator:ga291aef702f1c10bf2970394e3458022b"><td class="memSeparator" colspan="2">&#160;</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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.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">&#160;</td><td class="mdescRight">Get signal strength to WiFi network. <br /></td></tr>
-<tr class="separator:gaba16b9918e55c08285cf5b8b50dbabea"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga0b8fc3d5be0bae9ffcdc1b4b9aee6290"><td class="memItemLeft" align="right" valign="top">const char *&#160;</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">&#160;</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">&#160;</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>&#160;</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">&#160;</td><td class="mdescRight">Set static DNS Address. <br /></td></tr>
+<tr class="separator:ga258d8b80064c6ce311a433affe63a0e9"><td class="memSeparator" colspan="2">&#160;</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>&#160;</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">&#160;</td><td class="mdescRight">Get the static DNS address. <br /></td></tr>
+<tr class="separator:ga585cb71d386ee61db3772f4b3218cb6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gabd8eb629fd40defaa9ab22c189652a3f"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#gabd8eb629fd40defaa9ab22c189652a3f">getIpAddress</a> (char *buffer ALLOW_NULL_STRING_BUFFER)</td></tr>
+<tr class="memdesc:gabd8eb629fd40defaa9ab22c189652a3f"><td class="mdescLeft">&#160;</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#gabd8eb629fd40defaa9ab22c189652a3f">More...</a><br /></td></tr>
+<tr class="separator:gabd8eb629fd40defaa9ab22c189652a3f"><td class="memSeparator" colspan="2">&#160;</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>
@@ -186,10 +202,10 @@
 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>
 <tr class="memdesc:ga93bdb8669a70adaa61dc76073ce66591"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert string to IP address. <br /></td></tr>
 <tr class="separator:ga93bdb8669a70adaa61dc76073ce66591"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:gaff8b0af70f4d4be792b943ad3af27303"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaff8b0af70f4d4be792b943ad3af27303"></a>
-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>
-<tr class="memdesc:gaff8b0af70f4d4be792b943ad3af27303"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert IP address to string. <br /></td></tr>
-<tr class="separator:gaff8b0af70f4d4be792b943ad3af27303"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga02e6b01f11f2283208f051b1b49b634c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga02e6b01f11f2283208f051b1b49b634c"></a>
+static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga02e6b01f11f2283208f051b1b49b634c">ipToStr</a> (uint32_t ip, char *ipStrBuffer ALLOW_NULL_STRING_BUFFER)</td></tr>
+<tr class="memdesc:ga02e6b01f11f2283208f051b1b49b634c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert IP address to string. <br /></td></tr>
+<tr class="separator:ga02e6b01f11f2283208f051b1b49b634c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:gacff5a4927d79e8b4c0d5a3050f5950b0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gacff5a4927d79e8b4c0d5a3050f5950b0"></a>
 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__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">NetworkStatus</a> status)</td></tr>
 <tr class="memdesc:gacff5a4927d79e8b4c0d5a3050f5950b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert <a class="el" href="group__api__network__types.html#gab448e57fc1a5e21cbba0283fd1a35d99">NetworkStatus</a> to string. <br /></td></tr>
@@ -218,26 +234,26 @@
 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>
 <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>
 <tr class="separator:ga6a479a58591ead92dcf0586e11fcad17"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:gafce7929a10e16cf9be7307a2f97bef3f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gafce7929a10e16cf9be7307a2f97bef3f"></a>
-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>
-<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>
-<tr class="separator:gafce7929a10e16cf9be7307a2f97bef3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gae8b534c249d503aa764017bb088f3890"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae8b534c249d503aa764017bb088f3890"></a>
+static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#gae8b534c249d503aa764017bb088f3890">ssidToStr</a> (const <a class="el" href="structwiconnect_1_1_ssid.html">Ssid</a> *ssid, char *ssidStrBuffer ALLOW_NULL_STRING_BUFFER)</td></tr>
+<tr class="memdesc:gae8b534c249d503aa764017bb088f3890"><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>
+<tr class="separator:gae8b534c249d503aa764017bb088f3890"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ga347f05073370d6872a5cdac74de39b1b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga347f05073370d6872a5cdac74de39b1b"></a>
 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>
 <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>
 <tr class="separator:ga347f05073370d6872a5cdac74de39b1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga13ecaf390b4bf4a68b51a6b18e669134"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga13ecaf390b4bf4a68b51a6b18e669134"></a>
-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>
-<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>
-<tr class="separator:ga13ecaf390b4bf4a68b51a6b18e669134"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga01520d55f1923d90fb899ddef2f21cdf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga01520d55f1923d90fb899ddef2f21cdf"></a>
+static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__conversion__util.html#ga01520d55f1923d90fb899ddef2f21cdf">macAddressToStr</a> (const <a class="el" href="structwiconnect_1_1_mac_address.html">MacAddress</a> *macAddress, char *macStrBuffer ALLOW_NULL_STRING_BUFFER)</td></tr>
+<tr class="memdesc:ga01520d55f1923d90fb899ddef2f21cdf"><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>
+<tr class="separator:ga01520d55f1923d90fb899ddef2f21cdf"><td class="memSeparator" colspan="2">&#160;</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#l00049">49</a> of file <a class="el" href="_network_interface_8h_source.html">NetworkInterface.h</a>.</p>
+<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/<a class="el" href="_network_interface_8h_source.html">NetworkInterface.h</a></li>
+<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 -->