Newer
Older
UbixOS / doc / xml / group__lwip__opts__netconn.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__netconn" kind="group">
    <compoundname>lwip_opts_netconn</compoundname>
    <title>Netconn</title>
      <sectiondef kind="define">
      <memberdef kind="define" id="group__lwip__opts__netconn_1ga478041b8544461258f6961bf0f3c1a77" prot="public" static="no">
        <name>LWIP_NETCONN</name>
        <initializer>1</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>LWIP_NETCONN==1: Enable Netconn API (require to use <ref refid="api__lib_8c" kindref="compound">api_lib.c</ref>) </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/opt.h" line="1639" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/opt.h" bodystart="1639" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__lwip__opts__netconn_1ga7bfe8487a3abffdd9d6730977d22c406" prot="public" static="no">
        <name>LWIP_NETCONN_FULLDUPLEX</name>
        <initializer>0</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>LWIP_NETCONN_FULLDUPLEX==1: Enable code that allows reading from one thread, writing from a 2nd thread and closing from a 3rd thread at the same time. ATTENTION: This is currently really alpha! Some requirements:<itemizedlist>
<listitem><para>LWIP_NETCONN_SEM_PER_THREAD==1 is required to use one socket/netconn from multiple threads at once</para>
</listitem><listitem><para><ref refid="group__sys__mbox_1gad4a51a28337f89d4b4806e6deb99798d" kindref="member">sys_mbox_free()</ref> has to unblock receive tasks waiting on recvmbox/acceptmbox and prevent a task pending on this during/after deletion </para>
</listitem></itemizedlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/opt.h" line="1672" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/opt.h" bodystart="1672" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__lwip__opts__netconn_1ga2543345adf7d2c307df78a54ac2ba8c4" prot="public" static="no">
        <name>LWIP_NETCONN_SEM_PER_THREAD</name>
        <initializer>0</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>LWIP_NETCONN_SEM_PER_THREAD==1: Use one (thread-local) semaphore per thread calling socket/netconn functions instead of allocating one semaphore per netconn (and per select etc.) ATTENTION: a thread-local semaphore for API calls is needed:<itemizedlist>
<listitem><para>LWIP_NETCONN_THREAD_SEM_GET() returning a sys_sem_t*</para>
</listitem><listitem><para>LWIP_NETCONN_THREAD_SEM_ALLOC() creating the semaphore</para>
</listitem><listitem><para>LWIP_NETCONN_THREAD_SEM_FREE() freeing the semaphore The latter 2 can be invoked up by calling netconn_thread_init()/netconn_thread_cleanup(). Ports may call these for threads created with <ref refid="group__sys__misc_1ga0d596afdd8dbcfad320172d39b0f607a" kindref="member">sys_thread_new()</ref>. </para>
</listitem></itemizedlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/opt.h" line="1660" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/opt.h" bodystart="1660" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__lwip__opts__netconn_1ga1cd8d15a42262a0defaedabed126ea99" prot="public" static="no">
        <name>LWIP_TCPIP_TIMEOUT</name>
        <initializer>0</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>LWIP_TCPIP_TIMEOUT==1: Enable tcpip_timeout/tcpip_untimeout to create timers running in tcpip_thread from another thread. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/opt.h" line="1646" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/opt.h" bodystart="1646" bodyend="-1"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
  </compounddef>
</doxygen>