ot::NetworkData::Publisher::PublishOnMeshPrefix() method

Requests an on-mesh prefix to be published in the Thread Network Data. Only stable entries can be published (i.e.,`aConfig.mStable` MUST be `true`). A subsequent call to this method will replace a previous request for the same prefix. In particular if the new call only changes the flags (e.g., preference level) and the prefix is already added in the Network Data, the change to flags is immediately reflected in the Network Data. This ensures that existing entries in the Network Data are not abruptly removed. Note that a change in the preference level can potentially later cause the entry to be removed from the Network Data after determining there are other nodes that are publishing the same prefix with the same or higher preference.

Syntax

Show:

Summary

Declaration

Definition

from network_data_publisher.hpp:228

Error PublishOnMeshPrefix(const OnMeshPrefixConfig &aConfig, Requester aRequester);

Implemented in network_data_publisher.cpp:71

Arguments

Argument

Description

aConfig

The on-mesh prefix config to publish.

aRequester

The requester (`kFromUser` or `kFromRoutingManager` module).

Return value

kErrorNone The on-mesh prefix is published successfully. kErrorInvalidArgs The @p aConfig is not valid (bad prefix, invalid flag combinations, or not stable). kErrorAlready An entry with the same prefix is already in the published list. kErrorNoBufs Could not allocate an entry for the new request. Publisher supports a limited number of entries (shared between on-mesh prefix and external route) determined by config `OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES`.