Network Data Publisher

This module includes configuration variables for Network Data Publisher.

Summary

Macros

OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_ANYCAST_DNS_SRP_SERVICE_ENTRIES 8
Specifies the desired number of "DNS/SRP Service Anycast Address" entries in the Thread Network Data.
OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_EXTERNAL_ROUTE_ENTRIES 10
Specifies the desired number of matching External Route entries in the Thread Network Data.
OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_ON_MESH_PREFIX_ENTRIES 3
Specifies the desired number of matching On-mesh Prefix entries in the Thread Network Data.
OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_UNICAST_DNS_SRP_SERVICE_ENTRIES 2
Specifies the desired number of "DNS/SRP Service Anycast Address" entries in the Thread Network Data.
OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE (OPENTHREAD_CONFIG_SRP_SERVER_ENABLE || OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE)
Define to 1 to enable Network Data Publisher.
OPENTHREAD_CONFIG_NETDATA_PUBLISHER_EXTRA_DELAY_TIME_TO_REMOVE_PREFERRED 16000
Specifies the extra wait time (in milliseconds) used when removing a preferred entry.
OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_ADD 3500
Specifies the maximum value (in milliseconds) of the random delay used before adding an entry in the Thread Network Data.
OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_REMOVE 15000
Specifies the maximum value (in milliseconds) of the random wait time used before removing an entry from the Thread Network Data.
OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES 3
Specifies maximum number of prefix (on-mesh prefix or external route) entries reserved by Publisher for use by user (through OT public APIs).

Macros

OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_ANYCAST_DNS_SRP_SERVICE_ENTRIES

 OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_ANYCAST_DNS_SRP_SERVICE_ENTRIES 8

Specifies the desired number of "DNS/SRP Service Anycast Address" entries in the Thread Network Data.

Publisher attempts to limit the number of such entries to this value.

OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_EXTERNAL_ROUTE_ENTRIES

 OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_EXTERNAL_ROUTE_ENTRIES 10

Specifies the desired number of matching External Route entries in the Thread Network Data.

Publisher attempts to limit the number of matching entries to this value.

OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_ON_MESH_PREFIX_ENTRIES

 OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_ON_MESH_PREFIX_ENTRIES 3

Specifies the desired number of matching On-mesh Prefix entries in the Thread Network Data.

Publisher attempts to limit the number of matching entries to this value.

OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_UNICAST_DNS_SRP_SERVICE_ENTRIES

 OPENTHREAD_CONFIG_NETDATA_PUBLISHER_DESIRED_NUM_UNICAST_DNS_SRP_SERVICE_ENTRIES 2

Specifies the desired number of "DNS/SRP Service Anycast Address" entries in the Thread Network Data.

Publisher attempts to limit the number of such entries to this value.

OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE

 OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE (OPENTHREAD_CONFIG_SRP_SERVER_ENABLE || OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE)

Define to 1 to enable Network Data Publisher.

Network Data Publisher provides mechanisms to limit the number of similar Service and/or Prefix (on-mesh prefix or external route) entries in the Thread Network Data by monitoring the Network Data and managing if or when to add or remove entries.

OPENTHREAD_CONFIG_NETDATA_PUBLISHER_EXTRA_DELAY_TIME_TO_REMOVE_PREFERRED

 OPENTHREAD_CONFIG_NETDATA_PUBLISHER_EXTRA_DELAY_TIME_TO_REMOVE_PREFERRED 16000

Specifies the extra wait time (in milliseconds) used when removing a preferred entry.

When removing entries, certain entries are preferred over others. How the preference is determined depends on the entry type (e.g., (for DNS/SRP service entries associated with smaller RLOC16 or smaller IPv6 address are preferred). If the Publisher determines that its own entry is a preferred one, it adds the above extra wait time in addition to the random wait selected based on OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_REMOVE before removing its entry. This gives higher chance for a non-preferred entry from another device to be removed before removing a preferred entry which helps towards quicker convergence of the process to the desired number of entries.

It is recommended that OPENTHREAD_CONFIG_NETDATA_PUBLISHER_EXTRA_DELAY_TIME_TO_REMOVE_PREFERRED to be set to a value larger than OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_REMOVE to ensure that non-preferred entries are removed first.

OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_ADD

 OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_ADD 3500

Specifies the maximum value (in milliseconds) of the random delay used before adding an entry in the Thread Network Data.

OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_REMOVE

 OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_DELAY_TO_REMOVE 15000

Specifies the maximum value (in milliseconds) of the random wait time used before removing an entry from the Thread Network Data.

OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES

 OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES 3

Specifies maximum number of prefix (on-mesh prefix or external route) entries reserved by Publisher for use by user (through OT public APIs).

Resources

OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.