Newer
Older
UbixOS / doc / html / sntp_8h.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/>
<meta name="generator" content="Doxygen 1.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>UbixOS V2: C:/Dev/git/UbixOS/sys/include/net/apps/sntp.h File Reference</title>
<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="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">UbixOS V2
   &#160;<span id="projectnumber">2.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('sntp_8h.html','');});
/* @license-end */
</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)">
</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="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">sntp.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;lwip/apps/sntp_opts.h&quot;</code><br />
<code>#include &quot;lwip/ip_addr.h&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for sntp.h:</div>
<div class="dyncontent">
<div class="center"><img src="sntp_8h__incl.png" border="0" usemap="#C_1_2Dev_2git_2UbixOS_2sys_2include_2net_2apps_2sntp_8h" alt=""/></div>
</div>
</div>
<p><a href="sntp_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a55c14213293bd91ff0a55760bd77bb06"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sntp_8h.html#a55c14213293bd91ff0a55760bd77bb06">SNTP_OPMODE_LISTENONLY</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:a55c14213293bd91ff0a55760bd77bb06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3fb5749307bfe9d99a97f80fc49c2720"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sntp_8h.html#a3fb5749307bfe9d99a97f80fc49c2720">SNTP_OPMODE_POLL</a>&#160;&#160;&#160;0</td></tr>
<tr class="separator:a3fb5749307bfe9d99a97f80fc49c2720"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe7b6eae76f608a87fadc3940c5ee4f9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sntp_8h.html#afe7b6eae76f608a87fadc3940c5ee4f9">sntp_servermode_dhcp</a>(x)</td></tr>
<tr class="separator:afe7b6eae76f608a87fadc3940c5ee4f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a3fe5254e5a056fca80802d9f26b9c3c5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sntp_8h.html#a3fe5254e5a056fca80802d9f26b9c3c5">sntp_enabled</a> (void)</td></tr>
<tr class="separator:a3fe5254e5a056fca80802d9f26b9c3c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae66404a551d5cef420cf844a71356fae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sntp_8h.html#ae66404a551d5cef420cf844a71356fae">sntp_getoperatingmode</a> (void)</td></tr>
<tr class="separator:ae66404a551d5cef420cf844a71356fae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a28523cb9f2b5b025a4818bc2c1afc1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> <a class="el" href="ip__addr_8h.html#a88b43639738c4de2d3cd22e3a1fd7696">ip_addr_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sntp_8h.html#a2a28523cb9f2b5b025a4818bc2c1afc1">sntp_getserver</a> (<a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> idx)</td></tr>
<tr class="separator:a2a28523cb9f2b5b025a4818bc2c1afc1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b300c6616de60524c85ea40bf70e2ba"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sntp_8h.html#a9b300c6616de60524c85ea40bf70e2ba">sntp_init</a> (void)</td></tr>
<tr class="separator:a9b300c6616de60524c85ea40bf70e2ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae94fb2adadbf9667e9597f8a45bf120"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sntp_8h.html#aae94fb2adadbf9667e9597f8a45bf120">sntp_setoperatingmode</a> (<a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> operating_mode)</td></tr>
<tr class="separator:aae94fb2adadbf9667e9597f8a45bf120"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab653cfecd7e9826634fbea1b839c6554"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sntp_8h.html#ab653cfecd7e9826634fbea1b839c6554">sntp_setserver</a> (<a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> idx, <a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> <a class="el" href="ip__addr_8h.html#a88b43639738c4de2d3cd22e3a1fd7696">ip_addr_t</a> *addr)</td></tr>
<tr class="separator:ab653cfecd7e9826634fbea1b839c6554"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8119fc2d1ff7ff6eba511cc9c7167488"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sntp_8h.html#a8119fc2d1ff7ff6eba511cc9c7167488">sntp_stop</a> (void)</td></tr>
<tr class="separator:a8119fc2d1ff7ff6eba511cc9c7167488"><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>SNTP client API </p>

<p class="definition">Definition in file <a class="el" href="sntp_8h_source.html">sntp.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a55c14213293bd91ff0a55760bd77bb06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55c14213293bd91ff0a55760bd77bb06">&#9670;&nbsp;</a></span>SNTP_OPMODE_LISTENONLY</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SNTP_OPMODE_LISTENONLY&#160;&#160;&#160;1</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="sntp_8h_source.html#l00050">50</a> of file <a class="el" href="sntp_8h_source.html">sntp.h</a>.</p>

</div>
</div>
<a id="a3fb5749307bfe9d99a97f80fc49c2720"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3fb5749307bfe9d99a97f80fc49c2720">&#9670;&nbsp;</a></span>SNTP_OPMODE_POLL</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define SNTP_OPMODE_POLL&#160;&#160;&#160;0</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="sntp_8h_source.html#l00049">49</a> of file <a class="el" href="sntp_8h_source.html">sntp.h</a>.</p>

</div>
</div>
<a id="afe7b6eae76f608a87fadc3940c5ee4f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe7b6eae76f608a87fadc3940c5ee4f9">&#9670;&nbsp;</a></span>sntp_servermode_dhcp</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define sntp_servermode_dhcp</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">x</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="sntp_8h_source.html#l00069">69</a> of file <a class="el" href="sntp_8h_source.html">sntp.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a3fe5254e5a056fca80802d9f26b9c3c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3fe5254e5a056fca80802d9f26b9c3c5">&#9670;&nbsp;</a></span>sntp_enabled()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> sntp_enabled </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ae66404a551d5cef420cf844a71356fae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae66404a551d5cef420cf844a71356fae">&#9670;&nbsp;</a></span>sntp_getoperatingmode()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> sntp_getoperatingmode </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a2a28523cb9f2b5b025a4818bc2c1afc1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a28523cb9f2b5b025a4818bc2c1afc1">&#9670;&nbsp;</a></span>sntp_getserver()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> <a class="el" href="ip__addr_8h.html#a88b43639738c4de2d3cd22e3a1fd7696">ip_addr_t</a>* sntp_getserver </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a>&#160;</td>
          <td class="paramname"><em>idx</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a9b300c6616de60524c85ea40bf70e2ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b300c6616de60524c85ea40bf70e2ba">&#9670;&nbsp;</a></span>sntp_init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void sntp_init </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="aae94fb2adadbf9667e9597f8a45bf120"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae94fb2adadbf9667e9597f8a45bf120">&#9670;&nbsp;</a></span>sntp_setoperatingmode()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void sntp_setoperatingmode </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a>&#160;</td>
          <td class="paramname"><em>operating_mode</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ab653cfecd7e9826634fbea1b839c6554"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab653cfecd7e9826634fbea1b839c6554">&#9670;&nbsp;</a></span>sntp_setserver()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void sntp_setserver </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a>&#160;</td>
          <td class="paramname"><em>idx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> <a class="el" href="ip__addr_8h.html#a88b43639738c4de2d3cd22e3a1fd7696">ip_addr_t</a> *&#160;</td>
          <td class="paramname"><em>addr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a8119fc2d1ff7ff6eba511cc9c7167488"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8119fc2d1ff7ff6eba511cc9c7167488">&#9670;&nbsp;</a></span>sntp_stop()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void sntp_stop </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</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="navelem"><a class="el" href="dir_e6bb53534ac0e427887cf7a94c0c004e.html">C:</a></li><li class="navelem"><a class="el" href="dir_d99d5d4662bf24521eef49da6a8cd34d.html">Dev</a></li><li class="navelem"><a class="el" href="dir_474a4b306371cf7e7f6fa12cb0b77df6.html">git</a></li><li class="navelem"><a class="el" href="dir_849109bbd106d461b128d63e5babcedf.html">UbixOS</a></li><li class="navelem"><a class="el" href="dir_6ec99f6d7d5182ba8913209ab70c9f18.html">sys</a></li><li class="navelem"><a class="el" href="dir_d1be8160e739b6eed1f7843efdbae1b3.html">include</a></li><li class="navelem"><a class="el" href="dir_8a452844cab5a537277ef786999bc939.html">net</a></li><li class="navelem"><a class="el" href="dir_21e12f15c353f338a385e10009a09aca.html">apps</a></li><li class="navelem"><a class="el" href="sntp_8h.html">sntp.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.16 </li>
  </ul>
</div>
</body>
</html>