<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.16">
  <compounddef id="group__sntp__opts" kind="group">
    <compoundname>sntp_opts</compoundname>
    <title>Options</title>
      <sectiondef kind="define">
      <memberdef kind="define" id="group__sntp__opts_1ga7d4e12d90912d486e64f289d7f3ca446" prot="public" static="no">
        <name>SNTP_CHECK_RESPONSE</name>
        <initializer>0</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Set this to 1 to allow config of SNTP server(s) by DNS name Sanity check: Define this to<itemizedlist>
<listitem><para>0 to turn off sanity checks (default; smaller code)</para>
</listitem><listitem><para>&gt;= 1 to check address and port of the response packet to ensure the response comes from the server we sent the request to.</para>
</listitem><listitem><para>&gt;= 2 to check returned Originate Timestamp against Transmit Timestamp sent to the server (to ensure response to older request).</para>
</listitem><listitem><para>&gt;= 3 <xrefsect id="todo_1_todo000001"><xreftitle>Todo</xreftitle><xrefdescription><para>: discard reply if any of the LI, Stratum, or Transmit Timestamp fields is 0 or the Mode field is not 4 (unicast) or 5 (broadcast).</para>
</xrefdescription></xrefsect></para>
</listitem></itemizedlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" line="107" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" bodystart="107" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__sntp__opts_1ga25c6f9c14c17e218d110d826b09f8d91" prot="public" static="no">
        <name>SNTP_DEBUG</name>
        <initializer><ref refid="group__debugging__levels_1gadab1cdc3f45939a3a5c9a3d7e04987e1" kindref="member">LWIP_DBG_OFF</ref></initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>SNTP_DEBUG: Enable debugging for SNTP. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" line="79" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" bodystart="79" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__sntp__opts_1ga961a61eef942ab5378cff1e3742b3ade" prot="public" static="no">
        <name>SNTP_GET_SERVERS_FROM_DHCP</name>
        <initializer><ref refid="group__lwip__opts__dhcp_1ga2cc18315edcd5ffc083d1256f7d22a83" kindref="member">LWIP_DHCP_GET_NTP_SRV</ref></initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Set this to 1 to implement the callback function called by dhcp when NTP servers are received. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" line="64" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" bodystart="64" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__sntp__opts_1gab0ea385479a5c5c8c173f165ded2fb63" prot="public" static="no">
        <name>SNTP_GET_SYSTEM_TIME</name>
        <param><defname>sec</defname></param>
        <param><defname>us</defname></param>
        <initializer>do { (sec) = 0; (us) = 0; } while(0)</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>SNTP macro to get system time, used with SNTP_CHECK_RESPONSE &gt;= 2 to send in request and compare in response. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" line="146" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" bodystart="146" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__sntp__opts_1ga5d9dc0827f402849f5c18d44e311dbc2" prot="public" static="no">
        <name>SNTP_MAX_SERVERS</name>
        <initializer><ref refid="group__lwip__opts__dhcp_1ga9d014e3f7dc9e1e7c7decd8652ba65e2" kindref="member">LWIP_DHCP_MAX_NTP_SERVERS</ref></initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>The maximum number of SNTP servers that can be set </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" line="58" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" bodystart="58" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__sntp__opts_1gacbee62c27f54371fc2c5259a834a0f9b" prot="public" static="no">
        <name>SNTP_PORT</name>
        <initializer>123</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>SNTP server port </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" line="84" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" bodystart="84" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__sntp__opts_1ga44cf26b9b19832d88599244711a12d08" prot="public" static="no">
        <name>SNTP_RECV_TIMEOUT</name>
        <initializer>3000</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>SNTP receive timeout - in milliseconds Also used as retry timeout - this shouldn&apos;t be too low. Default is 3 seconds. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" line="132" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" bodystart="132" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__sntp__opts_1ga86d651d8eb07687208308deef95a23ba" prot="public" static="no">
        <name>SNTP_RETRY_TIMEOUT</name>
        <initializer><ref refid="group__sntp__opts_1ga44cf26b9b19832d88599244711a12d08" kindref="member">SNTP_RECV_TIMEOUT</ref></initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Default retry timeout (in milliseconds) if the response received is invalid. This is doubled with each retry until SNTP_RETRY_TIMEOUT_MAX is reached. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" line="154" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" bodystart="154" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__sntp__opts_1gafdb7e98f608cc429188d7dac356614c2" prot="public" static="no">
        <name>SNTP_RETRY_TIMEOUT_EXP</name>
        <initializer>1</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Increase retry timeout with every retry sent Default is on to conform to RFC. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" line="166" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" bodystart="166" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__sntp__opts_1gafde10b3ed7cb4bb2cd2c4daa389db699" prot="public" static="no">
        <name>SNTP_RETRY_TIMEOUT_MAX</name>
        <initializer>(<ref refid="group__sntp__opts_1ga86d651d8eb07687208308deef95a23ba" kindref="member">SNTP_RETRY_TIMEOUT</ref> * 10)</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Maximum retry timeout (in milliseconds). </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" line="159" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" bodystart="159" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__sntp__opts_1gaef477c145ae404d77188b26b79b6996f" prot="public" static="no">
        <name>SNTP_SERVER_DNS</name>
        <initializer>0</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Set this to 1 to support DNS names (or IP address strings) to set sntp servers One server address/name can be defined as default if SNTP_SERVER_DNS == 1: #define SNTP_SERVER_ADDRESS &quot;pool.ntp.org&quot; </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" line="72" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" bodystart="72" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__sntp__opts_1gafe340b98c52dedcbc041267fe13b2da6" prot="public" static="no">
        <name>SNTP_SET_SYSTEM_TIME</name>
        <param><defname>sec</defname></param>
        <initializer><ref refid="group__compiler__abstraction_1ga70624a5deb8b9199406372a7f3603ecf" kindref="member">LWIP_UNUSED_ARG</ref>(sec)</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>SNTP macro to change system time in seconds Define SNTP_SET_SYSTEM_TIME_US(sec, us) to set the time in microseconds instead of this one if you need the additional precision. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" line="53" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" bodystart="53" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__sntp__opts_1ga22017d43da7d4bf8d42e786b4ced4dfa" prot="public" static="no">
        <name>SNTP_STARTUP_DELAY</name>
        <initializer>0</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>According to the RFC, this shall be a random delay between 1 and 5 minutes (in milliseconds) to prevent load peaks. This can be defined to a random generation function, which must return the delay in milliseconds as u32_t. Turned off by default. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" line="117" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" bodystart="117" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__sntp__opts_1gae082c2f3044d500ca5e1be1d4928de75" prot="public" static="no">
        <name>SNTP_STARTUP_DELAY_FUNC</name>
        <initializer><ref refid="group__sntp__opts_1ga22017d43da7d4bf8d42e786b4ced4dfa" kindref="member">SNTP_STARTUP_DELAY</ref></initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>If you want the startup delay to be a function, define this to a function (including the brackets) and define SNTP_STARTUP_DELAY to 1. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" line="124" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" bodystart="124" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__sntp__opts_1ga9232c56443115be05a2f852eba21979c" prot="public" static="no">
        <name>SNTP_UPDATE_DELAY</name>
        <initializer>3600000</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>SNTP update delay - in milliseconds Default is 1 hour. Must not be beolw 15 seconds by specification (i.e. 15000) </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" line="139" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/sntp_opts.h" bodystart="139" bodyend="-1"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
  </compounddef>
</doxygen>
