ot::NetworkData::Service::Manager class

Manages the Thread Service entries in Thread Network Data.

Syntax

Show:

Summary

Declaration

from network_data_service.hpp:86

class Manager : public InstanceLocator, private NonCopyable { public: class Iterator : public Clearable<Iterator> { friend class Manager; public: Iterator(void) : mServiceTlv(nullptr) , mServerSubTlv(nullptr) { } void Reset(void) { mServiceTlv = nullptr; mServerSubTlv = nullptr; } private: const ServiceTlv *mServiceTlv; const ServerTlv *mServerSubTlv; }; explicit Manager(Instance &aInstance) : InstanceLocator(aInstance) { } #if OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE Error AddDnsSrpAnycastService(uint8_t aSequenceNumber) { return AddService(DnsSrpAnycastServiceData(aSequenceNumber)); } Error RemoveDnsSrpAnycastService(uint8_t aSequenceNumber) { return RemoveService(DnsSrpAnycastServiceData(aSequenceNumber)); } Error AddDnsSrpUnicastServiceWithAddrInServiceData(const Ip6::Address &aAddress, uint16_t aPort) { return AddService(DnsSrpUnicast::ServiceData(aAddress, aPort)); } Error RemoveDnsSrpUnicastServiceWithAddrInServiceData(const Ip6::Address &aAddress, uint16_t aPort) { return RemoveService(DnsSrpUnicast::ServiceData(aAddress, aPort)); } Error AddDnsSrpUnicastServiceWithAddrInServerData(const Ip6::Address &aAddress, uint16_t aPort) { return AddService(kDnsSrpUnicastServiceNumber, DnsSrpUnicast::ServerData(aAddress, aPort)); } Error RemoveDnsSrpUnicastServiceWithAddrInServerData(void) { return RemoveService(kDnsSrpUnicastServiceNumber); } #if (OPENTHREAD_CONFIG_THREAD_VERSION >= OT_THREAD_VERSION_1_2) Error AddBackboneRouterService(uint8_t aSequenceNumber, uint16_t aReregistrationDelay, uint32_t aMlrTimeout) { return AddService(kBackboneRouterServiceNumber, BbrServerData(aSequenceNumber, aReregistrationDelay, aMlrTimeout)); } Error RemoveBackboneRouterService(void) { return RemoveService(kBackboneRouterServiceNumber); } #endif #endif #if (OPENTHREAD_CONFIG_THREAD_VERSION >= OT_THREAD_VERSION_1_2) void GetBackboneRouterPrimary(ot::BackboneRouter::Config &aConfig) const; Error GetBackboneRouterServiceId(uint8_t &aServiceId) const { return GetServiceId(kBackboneRouterServiceNumber, aServiceId); } #endif Error GetNextDnsSrpAnycastInfo(Iterator &aIterator, DnsSrpAnycastInfo &aInfo) const; Error FindPreferredDnsSrpAnycastInfo(DnsSrpAnycastInfo &aInfo) const; Error GetNextDnsSrpUnicastInfo(Iterator &aIterator, DnsSrpUnicastType aType, DnsSrpUnicastInfo &aInfo) const; private: static constexpr uint8_t kBackboneRouterServiceNumber = 0x01; static constexpr uint8_t kDnsSrpAnycastServiceNumber = 0x5c; static constexpr uint8_t kDnsSrpUnicastServiceNumber = 0x5d; OT_TOOL_PACKED_BEGIN class DnsSrpAnycastServiceData { public: explicit DnsSrpAnycastServiceData(uint8_t aSequenceNumber) : mServiceNumber(kDnsSrpAnycastServiceNumber) , mSequenceNumber(aSequenceNumber) { OT_UNUSED_VARIABLE(mServiceNumber); } uint8_t GetSequenceNumber(void) const { return mSequenceNumber; } private: uint8_t mServiceNumber; uint8_t mSequenceNumber; } OT_TOOL_PACKED_END; class DnsSrpUnicast { public: OT_TOOL_PACKED_BEGIN struct ServiceData { public: explicit ServiceData(const Ip6::Address &aAddress, uint16_t aPort) : mServiceNumber(kDnsSrpUnicastServiceNumber) , mAddress(aAddress) , mPort(BigEndian::HostSwap16(aPort)) { OT_UNUSED_VARIABLE(mServiceNumber); } const Ip6::Address &GetAddress(void) const { return mAddress; } uint16_t GetPort(void) const { return BigEndian::HostSwap16(mPort); } private: uint8_t mServiceNumber; Ip6::Address mAddress; uint16_t mPort; } OT_TOOL_PACKED_END; OT_TOOL_PACKED_BEGIN class ServerData { public: ServerData(const Ip6::Address &aAddress, uint16_t aPort) : mAddress(aAddress) , mPort(BigEndian::HostSwap16(aPort)) { } const Ip6::Address &GetAddress(void) const { return mAddress; } uint16_t GetPort(void) const { return BigEndian::HostSwap16(mPort); } private: Ip6::Address mAddress; uint16_t mPort; } OT_TOOL_PACKED_END; DnsSrpUnicast(void) = delete; }; #if (OPENTHREAD_CONFIG_THREAD_VERSION >= OT_THREAD_VERSION_1_2) OT_TOOL_PACKED_BEGIN class BbrServerData { public: BbrServerData(uint8_t aSequenceNumber, uint16_t aReregDelay, uint32_t aMlrTimeout) : mSequenceNumber(aSequenceNumber) , mReregDelay(BigEndian::HostSwap16(aReregDelay)) , mMlrTimeout(BigEndian::HostSwap32(aMlrTimeout)) { } uint8_t GetSequenceNumber(void) const { return mSequenceNumber; } uint16_t GetReregistrationDelay(void) const { return BigEndian::HostSwap16(mReregDelay); } uint32_t GetMlrTimeout(void) const { return BigEndian::HostSwap32(mMlrTimeout); } private: uint8_t mSequenceNumber; uint16_t mReregDelay; uint32_t mMlrTimeout; } OT_TOOL_PACKED_END; #endif #if OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE template <typename ServiceDataType> Error AddService(const ServiceDataType &aServiceData) { return AddService(&aServiceData, sizeof(ServiceDataType), nullptr, 0); } template <typename ServerDataType> Error AddService(uint8_t aServiceNumber, const ServerDataType &aServerData) { return AddService(&aServiceNumber, sizeof(uint8_t), &aServerData, sizeof(ServerDataType)); } Error AddService(const void *aServiceData, uint8_t aServiceDataLength, const void *aServerData = nullptr, uint8_t aServerDataLength = 0); template <typename ServiceDataType> Error RemoveService(const ServiceDataType &aServiceData) { return RemoveService(&aServiceData, sizeof(ServiceDataType)); } Error RemoveService(uint8_t aServiceNumber) { return RemoveService(&aServiceNumber, sizeof(uint8_t)); } Error RemoveService(const void *aServiceData, uint8_t aServiceDataLength); #endif Error GetServiceId(uint8_t aServiceNumber, uint8_t &aServiceId) const; Error IterateToNextServer(Iterator &aIterator) const; #if (OPENTHREAD_CONFIG_THREAD_VERSION >= OT_THREAD_VERSION_1_2) bool IsBackboneRouterPreferredTo(const ServerTlv &aServerTlv, const BbrServerData &aServerData, const ServerTlv &aOtherServerTlv, const BbrServerData &aOtherServerData) const; #endif };

Fields

Field

ot::NetworkData::Service::Manager::kBackboneRouterServiceNumber

ot::NetworkData::Service::Manager::kDnsSrpAnycastServiceNumber

ot::NetworkData::Service::Manager::kDnsSrpUnicastServiceNumber

Methods

AddDnsSrpAnycastService()

Adds a DNS/SRP Anycast Service entry to the local Thread Network Data.

RemoveDnsSrpAnycastService()

Removes a DNS/SRP Anycast Service entry from local Thread Network Data.

AddDnsSrpUnicastServiceWithAddrInServiceData()

Adds a DNS/SRP Unicast Service entry with address in Service Data to the local Thread Network Data.

RemoveDnsSrpUnicastServiceWithAddrInServiceData()

Removes a DNS/SRP Unicast Service entry with address in Service Data from the local Thread Network Data.

AddDnsSrpUnicastServiceWithAddrInServerData()

Adds a DNS/SRP Unicast Service entry with address in Server Data to the local Thread Network Data.

RemoveDnsSrpUnicastServiceWithAddrInServerData()

Removes a DNS/SRP Unicast Service entry with address in Server Data from the local Thread Network Data.

AddBackboneRouterService()

Adds a Backbone Router Service entry to the local Thread Network Data.

RemoveBackboneRouterService()

Removes the Backbone Router Service entry from the local Thread Network Data.

GetBackboneRouterPrimary() const

Gets the Primary Backbone Router (PBBR) in the Thread Network Data.

GetBackboneRouterServiceId() const

Gets the Service ID of Backbone Router service from Thread Network Data.

GetNextDnsSrpAnycastInfo() const

Gets the next DNS/SRP info from the Thread Network Data "DNS/SRP Service Anycast Address" entries. To get the first entry, @p aIterator should be cleared (e.g., a new instance of `Iterator` or calling `Clear()` method).

FindPreferredDnsSrpAnycastInfo() const

Finds the preferred DNS/SRP info among all the Thread Network Data "DNS/SRP Service Anycast Address" entries. The preferred entry is determined based on the sequence number value where a larger value (in the sense specified by Serial Number Arithmetic logic in RFC-1982) is considered more recent and therefore preferred.

GetNextDnsSrpUnicastInfo() const

Gets the next DNS/SRP info from the Thread Network Data "DNS/SRP Service Unicast Address" entries. To get the first entry @p aIterator should be cleared (e.g., a new instance of `Iterator` or calling `Clear()` method).