Modules#
General#
This module includes functions for all Thread roles.
The 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.
All the functions in this module require OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE
to be enabled.
Note
The functions in this module require
OPENTHREAD_FTD=1
orOPENTHREAD_MTD=1
.
Enumerations#
Defines valid values for mPreference
in otExternalRouteConfig
and otBorderRouterConfig
.
This enumeration represents the events reported from the Publisher callbacks.
Represents a Thread device role.
Typedefs#
Used to iterate through Network Data information.
This structure represents a Border Router configuration.
This structure represents 6LoWPAN Context ID information associated with a prefix in Network Data.
This structure represents an External Route configuration.
Defines valid values for mPreference
in otExternalRouteConfig
and otBorderRouterConfig
.
This structure represents a Server configuration.
This structure represents a Service configuration.
This enumeration represents the events reported from the Publisher callbacks.
This function pointer type defines the callback used to notify when a "DNS/SRP Service" entry is added to or removed from the Thread Network Data.
This function pointer type defines the callback used to notify when a prefix (on-mesh or external route) entry is added to or removed from the Thread Network Data.
Used to iterate through Network Diagnostic TLV.
This structure represents a Network Diagnostic Connectivity value.
This structure represents a Network Diagnostic Route data.
This structure represents a Network Diagnostic Route TLV value.
This structure represents a Network Diagnostic Mac Counters value.
This structure represents a Network Diagnostic Child Table Entry.
This structure represents a Network Diagnostic TLV.
This function pointer is called when Network Diagnostic Get response is received.
This structure represents an MLE Link Mode configuration.
Used to iterate through neighbor table.
This structure represents the Thread Leader Data.
This structure represents the IP level counters.
This structure represents the Thread MLE counters.
This structure represents the MLE Parent Response data.
This callback informs the application that the detaching process has finished.
This function pointer is called every time an MLE Parent Response message is received.
This structure represents the Thread Discovery Request data.
This function pointer is called every time an MLE Discovery Request message is received.
This function pointer type defines the callback to notify the outcome of a otThreadLocateAnycastDestination()
request.
Functions#
Provide full or stable copy of the Partition's Thread Network Data.
Get the current length (number of bytes) of Partition's Thread Network Data.
Get the maximum observed length of the Thread Network Data since OT stack initialization or since the last call to otNetDataResetMaxLength()
.
Reset the tracked maximum length of the Thread Network Data.
Get the next On Mesh Prefix in the partition's Network Data.
Get the next external route in the partition's Network Data.
Get the next service in the partition's Network Data.
Get the next 6LoWPAN Context ID info in the partition's Network Data.
Get the Network Data Version.
Get the Stable Network Data Version.
Check if the steering data includes a Joiner.
Check if the steering data includes a Joiner with a given discerner value.
Check whether a given Prefix can act as a valid OMR prefix and also the Leader's Network Data contains this prefix.
This function requests "DNS/SRP Service Anycast Address" to be published in the Thread Network Data.
This function requests "DNS/SRP Service Unicast Address" to be published in the Thread Network Data.
This function requests "DNS/SRP Service Unicast Address" to be published in the Thread Network Data.
This function indicates whether or not currently the "DNS/SRP Service" entry is added to the Thread Network Data.
This function sets a callback for notifying when a published "DNS/SRP Service" is actually added to or removed from the Thread Network Data.
Unpublishes any previously added DNS/SRP (Anycast or Unicast) Service entry from the Thread Network Data.
This function requests an on-mesh prefix to be published in the Thread Network Data.