Newer
Older
UbixOS / doc / xml / group__lwip__opts__netif.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__netif" kind="group">
    <compoundname>lwip_opts_netif</compoundname>
    <title>NETIF</title>
    <innergroup refid="group__lwip__opts__loop">Loopback interface</innergroup>
      <sectiondef kind="define">
      <memberdef kind="define" id="group__lwip__opts__netif_1gadd45fb65f2d0e6de5a0d14ff9e101b77" prot="public" static="no">
        <name>LWIP_NETIF_API</name>
        <initializer>0</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>LWIP_NETIF_API==1: Support netif api (in <ref refid="netifapi_8c" kindref="compound">netifapi.c</ref>) </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/opt.h" line="1360" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/opt.h" bodystart="1360" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__lwip__opts__netif_1gaa714dbfa66822ec4c6111bdb8cf753c1" prot="public" static="no">
        <name>LWIP_NETIF_HOSTNAME</name>
        <initializer>0</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>LWIP_NETIF_HOSTNAME==1: use DHCP_OPTION_HOSTNAME with netif&apos;s hostname field. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/opt.h" line="1353" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/opt.h" bodystart="1353" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__lwip__opts__netif_1gad1d5e878d94b56ba687cef69be936ad9" prot="public" static="no">
        <name>LWIP_NETIF_HWADDRHINT</name>
        <initializer>0</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>LWIP_NETIF_HWADDRHINT==1: Cache link-layer-address hints (e.g. table indices) in struct netif. TCP and UDP can make use of this to prevent scanning the ARP table for every sent packet. While this is faster for big ARP tables or many concurrent connections, it might be counterproductive if you have a tiny ARP table or if there never are concurrent connections. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/opt.h" line="1395" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/opt.h" bodystart="1395" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__lwip__opts__netif_1ga1a446932dd927cc4136ba654c13bb97b" prot="public" static="no">
        <name>LWIP_NETIF_LINK_CALLBACK</name>
        <initializer>0</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>LWIP_NETIF_LINK_CALLBACK==1: Support a callback function from an interface whenever the link changes (i.e., link down) </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/opt.h" line="1376" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/opt.h" bodystart="1376" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__lwip__opts__netif_1ga9c942c2e9655b06d4f73c630d30f60bf" prot="public" static="no">
        <name>LWIP_NETIF_REMOVE_CALLBACK</name>
        <initializer>0</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>LWIP_NETIF_REMOVE_CALLBACK==1: Support a callback function that is called when a netif has been removed </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/opt.h" line="1384" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/opt.h" bodystart="1384" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__lwip__opts__netif_1gaffb97d89516c38d3fcb9e44e5d707f36" prot="public" static="no">
        <name>LWIP_NETIF_STATUS_CALLBACK</name>
        <initializer>0</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>LWIP_NETIF_STATUS_CALLBACK==1: Support a callback function whenever an interface changes its up/down status (i.e., due to DHCP IP acquisition) </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/opt.h" line="1368" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/opt.h" bodystart="1368" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__lwip__opts__netif_1gabafb9f64a80e51b56c0abbcfc1f7e04e" prot="public" static="no">
        <name>LWIP_NETIF_TX_SINGLE_PBUF</name>
        <initializer>0</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>LWIP_NETIF_TX_SINGLE_PBUF: if this is set to 1, lwIP tries to put all data to be sent into one single pbuf. This is for compatibility with DMA-enabled MACs that do not support scatter-gather. Beware that this might involve CPU-memcpy before transmitting that would not be needed without this flag! Use this only if you need to!</para>
<para><xrefsect id="todo_1_todo000002"><xreftitle>Todo</xreftitle><xrefdescription><para>: TCP and IP-frag do not work with this, yet: </para>
</xrefdescription></xrefsect></para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/opt.h" line="1408" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/opt.h" bodystart="1408" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__lwip__opts__netif_1ga94a35212616f9a9aae5c98741612b936" prot="public" static="no">
        <name>LWIP_NUM_NETIF_CLIENT_DATA</name>
        <initializer>0</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>LWIP_NUM_NETIF_CLIENT_DATA: Number of clients that may store data in client_data member array of struct netif. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/opt.h" line="1416" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/opt.h" bodystart="1416" bodyend="-1"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
  </compounddef>
</doxygen>