ACKme / WiConnect

Host library for controlling a WiConnect enabled Wi-Fi module.

Dependents:   wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more

doc/html/group__api__network__settings.html

Committer:
dan_ackme
Date:
2014-10-27
Revision:
29:b6af04b77a56
Parent:
26:8067e3d463d3

File content as of revision 29:b6af04b77a56:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>ACKme WiConnect Host Library</title>
<link rel="icon" href="favicon.ico" type="image/x-icon">
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea" style="font-family:verdana;">
    <table border='0' cellpadding='0' cellspacing='0' width="98%">
      <tr style="height:20px"><td>&nbsp;</td></tr>
      <tr style="border-collapse: collapse; padding: 0;">
        <td style="width:20px"></td>
        <td style="padding-right:40px"><img src="ackmelogo.png" alt="ACKme Logo" /></td>
        <td style="vertical-align:middle; text-align:left; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
        WiConnect Host Library- API Reference Guide</td>
        <td style="width:20px"></td>
      </tr>
      <tr><td>&nbsp;</td></tr>
    </table>
</div><!-- Generated by Doxygen 1.8.7 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Library&#160;Overview</span></a></li>
      <li><a href="modules.html"><span>Library&#160;API</span></a></li>
      <li><a href="examples.html"><span>API&#160;Examples</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="http://wiconnect.ack.me/2.0/general_overview"><span>WiConnect&#160;Reference&#160;Manual</span></a></li>
      <li><a href="http://www.ack.me/WiConnect"><span>ACKme&#160;Website</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div><!-- 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('group__api__network__settings.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Settings Methods<div class="ingroups"><a class="el" href="group__api__network.html">Network</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>API getters/setters for module network settings.  
<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:ga65eb99f880ed739d0f3cd393e5b56eaf"><td class="memItemLeft" align="right" valign="top">WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#ga65eb99f880ed739d0f3cd393e5b56eaf">wiconnect::NetworkInterface::setDhcpEnabled</a> (bool enabled)</td></tr>
<tr class="memdesc:ga65eb99f880ed739d0f3cd393e5b56eaf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set DHCP enabled.  <a href="#ga65eb99f880ed739d0f3cd393e5b56eaf">More...</a><br /></td></tr>
<tr class="separator:ga65eb99f880ed739d0f3cd393e5b56eaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga70ec796b88eb6f8e7990dbf3eb2f2eff"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga70ec796b88eb6f8e7990dbf3eb2f2eff"></a>
WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#ga70ec796b88eb6f8e7990dbf3eb2f2eff">wiconnect::NetworkInterface::getDhcpEnabled</a> (bool *enabledPtr)</td></tr>
<tr class="memdesc:ga70ec796b88eb6f8e7990dbf3eb2f2eff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get if DHCP enabled. <br /></td></tr>
<tr class="separator:ga70ec796b88eb6f8e7990dbf3eb2f2eff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2f7ec21084d3f2835d9c1c201915a9e0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2f7ec21084d3f2835d9c1c201915a9e0"></a>
WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#ga2f7ec21084d3f2835d9c1c201915a9e0">wiconnect::NetworkInterface::setIpSettings</a> (uint32_t ip, uint32_t netmask, uint32_t gateway)</td></tr>
<tr class="memdesc:ga2f7ec21084d3f2835d9c1c201915a9e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set static IP settings. <br /></td></tr>
<tr class="separator:ga2f7ec21084d3f2835d9c1c201915a9e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa418175dd3d06b870f3dd8e035cb4dd0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa418175dd3d06b870f3dd8e035cb4dd0"></a>
WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#gaa418175dd3d06b870f3dd8e035cb4dd0">wiconnect::NetworkInterface::setIpSettings</a> (const char *ip, const char *netmask, const char *gateway)</td></tr>
<tr class="memdesc:gaa418175dd3d06b870f3dd8e035cb4dd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set static IP settings (with string parameters) <br /></td></tr>
<tr class="separator:gaa418175dd3d06b870f3dd8e035cb4dd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga291aef702f1c10bf2970394e3458022b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga291aef702f1c10bf2970394e3458022b"></a>
WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#ga291aef702f1c10bf2970394e3458022b">wiconnect::NetworkInterface::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:ga258d8b80064c6ce311a433affe63a0e9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga258d8b80064c6ce311a433affe63a0e9"></a>
WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#ga258d8b80064c6ce311a433affe63a0e9">wiconnect::NetworkInterface::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>
WiconnectResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__network__settings.html#ga585cb71d386ee61db3772f4b3218cb6e">wiconnect::NetworkInterface::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">wiconnect::NetworkInterface::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="#gabd8eb629fd40defaa9ab22c189652a3f">More...</a><br /></td></tr>
<tr class="separator:gabd8eb629fd40defaa9ab22c189652a3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>API getters/setters for module network settings. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gabd8eb629fd40defaa9ab22c189652a3f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* wiconnect::NetworkInterface::getIpAddress </td>
          <td>(</td>
          <td class="paramtype">char *buffer&#160;</td>
          <td class="paramname"><em>ALLOW_NULL_STRING_BUFFER</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Return the current IP address of the module if possible, else return 0.0.0.0. </p>
<dl class="section note"><dt>Note</dt><dd>This method is only supported in blocking mode.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>Optional, buffer to IP address string. If omitted, the IP address string is stored in a local static buffer (this is non-reentrant!) </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ga65eb99f880ed739d0f3cd393e5b56eaf"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">WiconnectResult wiconnect::NetworkInterface::setDhcpEnabled </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>enabled</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set DHCP enabled. </p>
<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 -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">&copy; ACKme Networks 2014</li>
  </ul>
</div>
</body>
</html>