ot::Utils::Slaac class

Implements the SLAAC utility for Thread protocol.

Syntax

Show:

Summary

Declaration

from slaac_address.hpp:62

class Slaac : public InstanceLocator, private NonCopyable { friend class ot::Notifier; public: typedef otIp6SlaacPrefixFilter PrefixFilter; struct IidSecretKey { static constexpr uint16_t kSize = 32; uint8_t m8[kSize]; }; explicit Slaac(Instance &aInstance); void Enable(void); void Disable(void); bool IsEnabled(void) const { return mEnabled; } void SetFilter(PrefixFilter aFilter); Error GenerateIid(Ip6::Netif::UnicastAddress &aAddress, uint8_t &aDadCounter) const; Error FindDomainIdFor(const Ip6::Address &aAddress, uint8_t &aDomainId) const; private: static constexpr uint16_t kNumSlaacAddresses = OPENTHREAD_CONFIG_IP6_SLAAC_NUM_ADDRESSES; static constexpr uint16_t kMaxIidCreationAttempts = 256; static constexpr uint32_t kDeprecationInterval = TimeMilli::SecToMsec(OPENTHREAD_CONFIG_IP6_SLAAC_DEPRECATION_INTERVAL); enum Action : uint8_t { kAdding, kRemoving, kDeprecating, }; class SlaacAddress : public Ip6::Netif::UnicastAddress { public: static constexpr uint8_t kInvalidContextId = 0; bool IsInUse(void) const { return mValid; } void MarkAsNotInUse(void) { mValid = false; } uint8_t GetContextId(void) const { return mContextId; } void SetContextId(uint8_t aContextId) { mContextId = aContextId; } uint8_t GetDomainId(void) const { return mDomainId; } void SetDomainId(uint8_t aDomainId) { mDomainId = aDomainId; } bool IsDeprecating(void) const { return (mExpirationTime.GetValue() != kNotDeprecated); }; void MarkAsNotDeprecating(void) { mExpirationTime.SetValue(kNotDeprecated); } TimeMilli GetExpirationTime(void) const { return mExpirationTime; } void SetExpirationTime(TimeMilli aTime) { mExpirationTime = aTime; if (mExpirationTime.GetValue() == kNotDeprecated) { mExpirationTime.SetValue(kNotDeprecated + 1); } } private: static constexpr uint32_t kNotDeprecated = 0; uint8_t mContextId; uint8_t mDomainId; TimeMilli mExpirationTime; }; bool IsSlaac(const NetworkData::OnMeshPrefixConfig &aConfig) const; bool IsFiltered(const NetworkData::OnMeshPrefixConfig &aConfig) const; void RemoveOrDeprecateAddresses(void); void RemoveAllAddresses(void); void AddAddresses(void); void DeprecateAddress(SlaacAddress &aAddress); void RemoveAddress(SlaacAddress &aAddress); void AddAddressFor(const NetworkData::OnMeshPrefixConfig &aConfig); bool UpdateContextIdFor(SlaacAddress &aSlaacAddress); void HandleTimer(void); void GetIidSecretKey(IidSecretKey &aKey) const; void HandleNotifierEvents(Events aEvents); void LogAddress(Action aAction, const SlaacAddress &aAddress); static bool DoesConfigMatchNetifAddr(const NetworkData::OnMeshPrefixConfig &aConfig, const Ip6::Netif::UnicastAddress &aAddr); using ExpireTimer = TimerMilliIn<Slaac, &Slaac::HandleTimer>; bool mEnabled; PrefixFilter mFilter; ExpireTimer mTimer; SlaacAddress mSlaacAddresses[kNumSlaacAddresses]; };

Fields

Field

Declared as

ot::Utils::Slaac::kNumSlaacAddresses

ot::Utils::Slaac::kMaxIidCreationAttempts

ot::Utils::Slaac::kDeprecationInterval

ot::Utils::Slaac::mEnabled

bool

ot::Utils::Slaac::mFilter

PrefixFilter

ot::Utils::Slaac::mTimer

ExpireTimer

ot::Utils::Slaac::mSlaacAddresses

SlaacAddress[kNumSlaacAddresses]

Methods

Enable()

Enables the SLAAC module. When enabled, new SLAAC addresses are generated and added from on-mesh prefixes in network data.

Disable()

Disables the SLAAC module. When disabled, any previously added SLAAC address by this module is removed.

IsEnabled() const

Indicates whether SLAAC module is enabled or not.

SetFilter()

Sets a SLAAC prefix filter handler. The handler is invoked by SLAAC module when it is about to add a SLAAC address based on a prefix. The return boolean value from handler determines whether the address is filtered or added (TRUE to filter the address, FALSE to add address). The filter can be set to `nullptr` to disable filtering (i.e., allow SLAAC addresses for all prefixes).

GenerateIid() const

Generates the IID of an IPv6 address.

FindDomainIdFor() const

Searches in the list of deprecating SLAAC prefixes for a match to a given address and if found, returns the Domain ID from the Prefix TLV in the Network Data for this SLAAC prefix. The `Slaac` module keeps track of the associated Domain IDs for deprecating SLAAC prefixes, even if the related Prefix TLV has already been removed from the Network Data. This information is used during external route lookup if a deprecating SLAAC address is used as the source address in an outbound message.