Newer
Older
UbixOS / doc / xml / group__lwip__opts__dhcp.xml
<?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__lwip__opts__dhcp" kind="group">
    <compoundname>lwip_opts_dhcp</compoundname>
    <title>DHCP</title>
      <sectiondef kind="define">
      <memberdef kind="define" id="group__lwip__opts__dhcp_1gab2d91de7b2fce879b0a213682e1b0b69" prot="public" static="no">
        <name>DHCP_DOES_ARP_CHECK</name>
        <initializer>((<ref refid="group__lwip__opts__dhcp_1ga8a6ec62dc121064ac591b1fd8567bee9" kindref="member">LWIP_DHCP</ref>) &amp;&amp; (<ref refid="group__lwip__opts__arp_1ga9609a014bba4638cc191d6a8f9556c87" kindref="member">LWIP_ARP</ref>))</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>DHCP_DOES_ARP_CHECK==1: Do an ARP check on the offered address. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/opt.h" line="810" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/opt.h" bodystart="810" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__lwip__opts__dhcp_1ga8a6ec62dc121064ac591b1fd8567bee9" prot="public" static="no">
        <name>LWIP_DHCP</name>
        <initializer>0</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>LWIP_DHCP==1: Enable DHCP module. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/opt.h" line="798" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/opt.h" bodystart="798" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__lwip__opts__dhcp_1ga3c2983cbd228011dd3e18cb417e7e423" prot="public" static="no">
        <name>LWIP_DHCP_BOOTP_FILE</name>
        <initializer>0</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>LWIP_DHCP_BOOTP_FILE==1: Store offered_si_addr and boot_file_name. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/opt.h" line="827" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/opt.h" bodystart="827" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__lwip__opts__dhcp_1ga1e9ec404a96581fdbc9d231a8a698a60" prot="public" static="no">
        <name>LWIP_DHCP_CHECK_LINK_UP</name>
        <initializer>0</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>LWIP_DHCP_CHECK_LINK_UP==1: dhcp_start() only really starts if the netif has NETIF_FLAG_LINK_UP set in its flags. As this is only an optimization and netif drivers might not set this flag, the default is off. If enabled, <ref refid="group__netif_1gae0d2975f189277990e9d5276fdd9e9ea" kindref="member">netif_set_link_up()</ref> must be called to continue dhcp starting. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/opt.h" line="820" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/opt.h" bodystart="820" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__lwip__opts__dhcp_1ga2cc18315edcd5ffc083d1256f7d22a83" prot="public" static="no">
        <name>LWIP_DHCP_GET_NTP_SRV</name>
        <initializer>0</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>LWIP_DHCP_GETS_NTP==1: Request NTP servers with discover/select. For each response packet, an callback is called, which has to be provided by the port: void dhcp_set_ntp_servers(u8_t num_ntp_servers, ip_addr_t* ntp_server_addrs); </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/opt.h" line="836" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/opt.h" bodystart="836" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__lwip__opts__dhcp_1ga60ccc20fbb08be24b5d5f599dd47a6a6" prot="public" static="no">
        <name>LWIP_DHCP_MAX_DNS_SERVERS</name>
        <initializer><ref refid="group__lwip__opts__dns_1ga9f9881c887a8aceb9765820c2dbdf292" kindref="member">DNS_MAX_SERVERS</ref></initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>LWIP_DHCP_MAX_DNS_SERVERS &gt; 0: Request DNS servers with discover/select. DHCP servers received in the response are passed to DNS via dns_setserver() (up to the maximum limit defined here). </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/opt.h" line="852" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/opt.h" bodystart="852" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__lwip__opts__dhcp_1ga9d014e3f7dc9e1e7c7decd8652ba65e2" prot="public" static="no">
        <name>LWIP_DHCP_MAX_NTP_SERVERS</name>
        <initializer>1</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>The maximum of NTP servers requested </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/opt.h" line="843" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/opt.h" bodystart="843" bodyend="-1"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
  </compounddef>
</doxygen>