<?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__snmp__opts" kind="group">
    <compoundname>snmp_opts</compoundname>
    <title>Options</title>
      <sectiondef kind="define">
      <memberdef kind="define" id="group__snmp__opts_1gaf4900859dc53f19f5f67cc34e48ad68c" prot="public" static="no">
        <name>LWIP_SNMP</name>
        <initializer>0</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>LWIP_SNMP==1: This enables the lwIP SNMP agent. UDP must be available for SNMP transport. If you want to use your own SNMP agent, leave this disabled. To integrate MIB2 of an external agent, you need to enable LWIP_MIB2_CALLBACKS and MIB2_STATS. This will give you the callbacks and statistics counters you need to get MIB2 working. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" line="57" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" bodystart="57" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__snmp__opts_1ga316c1e1f06f0c7ca56589563809e64db" prot="public" static="no">
        <name>SNMP_COMMUNITY</name>
        <initializer>&quot;public&quot;</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>The snmp read-access community. Used for write-access and traps, too unless SNMP_COMMUNITY_WRITE or SNMP_COMMUNITY_TRAP are enabled, respectively. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" line="150" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" bodystart="150" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__snmp__opts_1gaaefc9dda5f8e5c296018a463cdbac39b" prot="public" static="no">
        <name>SNMP_COMMUNITY_TRAP</name>
        <initializer>&quot;public&quot;</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>The snmp community used for sending traps. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" line="165" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" bodystart="165" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__snmp__opts_1gafb9414dc7a33978b62a3a9838b659464" prot="public" static="no">
        <name>SNMP_COMMUNITY_WRITE</name>
        <initializer>&quot;private&quot;</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>The snmp write-access community. Set this community to &quot;&quot; in order to disallow any write access. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" line="158" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" bodystart="158" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__snmp__opts_1gac041000361342f51ad5ee5d8f6254e02" prot="public" static="no">
        <name>SNMP_DEBUG</name>
        <initializer><ref refid="group__debugging__levels_1gadab1cdc3f45939a3a5c9a3d7e04987e1" kindref="member">LWIP_DBG_OFF</ref></initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>SNMP_DEBUG: Enable debugging for SNMP messages. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" line="206" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" bodystart="206" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__snmp__opts_1ga09118b734e85df152af098744e888b34" prot="public" static="no">
        <name>SNMP_DEVICE_ENTERPRISE_OID</name>
        <initializer>{1, 3, 6, 1, 4, 1, <ref refid="group__snmp__opts_1ga868bfef6efe05515c86291137a633479" kindref="member">SNMP_LWIP_ENTERPRISE_OID</ref>}</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>IANA assigned enterprise ID for lwIP is 26381 <simplesect kind="see"><para><ulink url="http://www.iana.org/assignments/enterprise-numbers">http://www.iana.org/assignments/enterprise-numbers</ulink></para>
</simplesect>
<simplesect kind="note"><para>this enterprise ID is assigned to the lwIP project, all object identifiers living under this ID are assigned by the lwIP maintainers! </para>
</simplesect>
<simplesect kind="note"><para>don&apos;t change this define, use snmp_set_device_enterprise_oid()</para>
</simplesect>
If you need to create your own private MIB you&apos;ll need to apply for your own enterprise ID with IANA: <ulink url="http://www.iana.org/numbers.html">http://www.iana.org/numbers.html</ulink> </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" line="195" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" bodystart="195" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__snmp__opts_1ga9e39ba5308f5c7ac5296c7d05fdfa97f" prot="public" static="no">
        <name>SNMP_DEVICE_ENTERPRISE_OID_LEN</name>
        <initializer>7</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Length of SNMP_DEVICE_ENTERPRISE_OID </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" line="199" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" bodystart="199" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__snmp__opts_1ga868bfef6efe05515c86291137a633479" prot="public" static="no">
        <name>SNMP_LWIP_ENTERPRISE_OID</name>
        <initializer>26381</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>The OID identifiying the device. This may be the enterprise OID itself or any OID located below it in tree. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" line="181" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" bodystart="181" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__snmp__opts_1ga5a24152aa5f3c2837b9a3145aa3c59f3" prot="public" static="no">
        <name>SNMP_LWIP_GETBULK_MAX_REPETITIONS</name>
        <initializer>0</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>This value is used to limit the repetitions processed in GetBulk requests (value == 0 means no limitation). This may be useful to limit the load for a single request. According to SNMP RFC 1905 it is allowed to not return all requested variables from a GetBulk request if system load would be too high. so the effect is that the client will do more requests to gather all data. For the stack this could be useful in case that SNMP processing is done in TCP/IP thread. In this situation a request with many repetitions could block the thread for a longer time. Setting limit here will keep the stack more responsive. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" line="263" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" bodystart="263" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__snmp__opts_1gaab667d48f48ee89f8bdbc7f134e6037d" prot="public" static="no">
        <name>SNMP_LWIP_MIB2</name>
        <initializer><ref refid="group__snmp__opts_1gaf4900859dc53f19f5f67cc34e48ad68c" kindref="member">LWIP_SNMP</ref></initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Indicates if the MIB2 implementation of LWIP SNMP stack is used. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" line="220" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" bodystart="220" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__snmp__opts_1ga1a57501c615b630d363e0af1a504e683" prot="public" static="no">
        <name>SNMP_LWIP_MIB2_SYSCONTACT</name>
        <initializer>&quot;&quot;</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Value return for sysContact field of MIB2. To make sysContact field settable, call snmp_mib2_set_syscontact() to provide the necessary buffers. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" line="243" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" bodystart="243" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__snmp__opts_1gae93a105b421a2ca91e862da5087cec73" prot="public" static="no">
        <name>SNMP_LWIP_MIB2_SYSDESC</name>
        <initializer>&quot;lwIP&quot;</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Value return for sysDesc field of MIB2. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" line="227" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" bodystart="227" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__snmp__opts_1ga311cec98c8f7e4851d325fffe96cf8d9" prot="public" static="no">
        <name>SNMP_LWIP_MIB2_SYSLOCATION</name>
        <initializer>&quot;&quot;</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Value return for sysLocation field of MIB2. To make sysLocation field settable, call snmp_mib2_set_syslocation() to provide the necessary buffers. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" line="251" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" bodystart="251" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__snmp__opts_1ga80ba46f9517a51b5477f13082b2bcf98" prot="public" static="no">
        <name>SNMP_LWIP_MIB2_SYSNAME</name>
        <initializer>&quot;FQDN-unk&quot;</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Value return for sysName field of MIB2. To make sysName field settable, call snmp_mib2_set_sysname() to provide the necessary buffers. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" line="235" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" bodystart="235" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__snmp__opts_1ga0e98b58159a77688f87f9f50479177fd" prot="public" static="no">
        <name>SNMP_MAX_COMMUNITY_STR_LEN</name>
        <initializer><ref refid="def_8h_1a21ea174d374106caeafb4aa3a24fbd2b" kindref="member">LWIP_MAX</ref>(<ref refid="def_8h_1a21ea174d374106caeafb4aa3a24fbd2b" kindref="member">LWIP_MAX</ref>(sizeof(<ref refid="group__snmp__opts_1ga316c1e1f06f0c7ca56589563809e64db" kindref="member">SNMP_COMMUNITY</ref>), sizeof(<ref refid="group__snmp__opts_1gafb9414dc7a33978b62a3a9838b659464" kindref="member">SNMP_COMMUNITY_WRITE</ref>)), sizeof(<ref refid="group__snmp__opts_1gaaefc9dda5f8e5c296018a463cdbac39b" kindref="member">SNMP_COMMUNITY_TRAP</ref>))</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>The maximum length of community string. If community names shall be adjusted at runtime via snmp_set_community() calls, enter here the possible maximum length (+1 for terminating null character). </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" line="174" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" bodystart="174" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__snmp__opts_1ga3ad9d293f90e3c885c4e3263a9064a41" prot="public" static="no">
        <name>SNMP_MAX_OBJ_ID_LEN</name>
        <initializer>50</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>The maximum number of Sub ID&apos;s inside an object identifier. Indirectly this also limits the maximum depth of SNMP tree. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" line="131" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" bodystart="131" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__snmp__opts_1gae50cdd09697aa54a8b9f26432ac55ac2" prot="public" static="no">
        <name>SNMP_MAX_OCTET_STRING_LEN</name>
        <initializer>127</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>The maximum length of strings used. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" line="123" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" bodystart="123" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__snmp__opts_1gafb4362575bc50476a7401a1ed14787f0" prot="public" static="no">
        <name>SNMP_MAX_VALUE_SIZE</name>
        <initializer><ref refid="def_8h_1a21ea174d374106caeafb4aa3a24fbd2b" kindref="member">LWIP_MAX</ref>(<ref refid="def_8h_1a21ea174d374106caeafb4aa3a24fbd2b" kindref="member">LWIP_MAX</ref>((<ref refid="group__snmp__opts_1gae50cdd09697aa54a8b9f26432ac55ac2" kindref="member">SNMP_MAX_OCTET_STRING_LEN</ref>), sizeof(<ref refid="group__compiler__abstraction_1ga4c14294869aceba3ef9d4c0c302d0f33" kindref="member">u32_t</ref>)*(<ref refid="group__snmp__opts_1ga3ad9d293f90e3c885c4e3263a9064a41" kindref="member">SNMP_MAX_OBJ_ID_LEN</ref>)), <ref refid="group__snmp__opts_1gac815d0dbe576299546ac612e7eaf3f90" kindref="member">SNMP_MIN_VALUE_SIZE</ref>)</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>The minimum size of a value. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" line="142" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" bodystart="142" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__snmp__opts_1gac12240265db443eaf9d31d187e586c16" prot="public" static="no">
        <name>SNMP_MIB_DEBUG</name>
        <initializer><ref refid="group__debugging__levels_1gadab1cdc3f45939a3a5c9a3d7e04987e1" kindref="member">LWIP_DBG_OFF</ref></initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>SNMP_MIB_DEBUG: Enable debugging for SNMP MIBs. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" line="213" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" bodystart="213" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__snmp__opts_1gac815d0dbe576299546ac612e7eaf3f90" prot="public" static="no">
        <name>SNMP_MIN_VALUE_SIZE</name>
        <initializer>(2 * sizeof(<ref refid="group__compiler__abstraction_1ga4c14294869aceba3ef9d4c0c302d0f33" kindref="member">u32_t</ref>*)) /* size required to store the basic types (8 bytes for counter64) */</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>The maximum size of a value. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" line="138" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" bodystart="138" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__snmp__opts_1ga95e39047b9bcb385780b06b35af49261" prot="public" static="no">
        <name>SNMP_SAFE_REQUESTS</name>
        <initializer>1</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Only allow SNMP write actions that are &apos;safe&apos; (e.g. disabling netifs is not a safe action and disabled when SNMP_SAFE_REQUESTS = 1). Unsafe requests are disabled by default! </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" line="116" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" bodystart="116" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__snmp__opts_1ga692343b0cc555c302fd713003d4f8a08" prot="public" static="no">
        <name>SNMP_TRAP_DESTINATIONS</name>
        <initializer>1</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>SNMP_TRAP_DESTINATIONS: Number of trap destinations. At least one trap destination is required </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" line="107" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" bodystart="107" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__snmp__opts_1gaf02e8b4b69e99df784e9953401477078" prot="public" static="no">
        <name>SNMP_USE_NETCONN</name>
        <initializer>0</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>SNMP_USE_NETCONN: Use netconn API instead of raw API. Makes SNMP agent run in a worker thread, so blocking operations can be done in MIB calls. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" line="66" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" bodystart="66" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="group__snmp__opts_1ga8c93f4260af2eb3c50d4bc603f716f1f" prot="public" static="no">
        <name>SNMP_USE_RAW</name>
        <initializer>1</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>SNMP_USE_RAW: Use raw API. SNMP agent does not run in a worker thread, so blocking operations should not be done in MIB calls. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" line="75" column="9" bodyfile="C:/Dev/git/UbixOS/sys/include/net/apps/snmp_opts.h" bodystart="75" bodyend="-1"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
  </compounddef>
</doxygen>