Symbols ![]()
loading...
Files ![]()
loading...
ot::NetworkData::Leader class
Implements the Thread Network Data maintained by the Leader.
Syntax
class Leader : public MutableNetworkData,
private NonCopyable
{
friend class Tmf::Agent;
friend class Notifier;
public:
explicit Leader(Instance &aInstance);
void Reset(void);
uint8_t GetMaxLength(void) const { return mMaxLength; }
void ResetMaxLength(void) { mMaxLength = GetLength(); }
uint8_t GetVersion(Type aType) const { return (aType == kFullSet) ? mVersion : mStableVersion; }
Error GetContext(const Ip6::Address &aAddress, Lowpan::Context &aContext) const;
Error GetContext(uint8_t aContextId, Lowpan::Context &aContext) const;
bool IsOnMesh(const Ip6::Address &aAddress) const;
Error RouteLookup(const Ip6::Address &aSource, const Ip6::Address &aDestination, uint16_t &aRloc16) const;
Error SetNetworkData(uint8_t aVersion,
uint8_t aStableVersion,
Type aType,
const Message &aMessage,
const OffsetRange &aOffsetRange);
void GetCommissioningDataset(MeshCoP::CommissioningDataset &aDataset) const;
Coap::Message *ProcessCommissionerGetRequest(const Coap::Message &aMessage) const;
template <typename SubTlvType> const SubTlvType *FindInCommissioningData(void) const
{
return As<SubTlvType>(FindCommissioningDataSubTlv(SubTlvType::kType));
}
template <typename SubTlvType> SubTlvType *FindInCommissioningData(void)
{
return As<SubTlvType>(FindCommissioningDataSubTlv(SubTlvType::kType));
}
Error FindCommissioningSessionId(uint16_t &aSessionId) const;
Error FindBorderAgentRloc(uint16_t &aRloc16) const;
Error FindJoinerUdpPort(uint16_t &aPort) const;
Error FindSteeringData(MeshCoP::SteeringData &aSteeringData) const;
bool IsJoiningAllowed(void) const;
Error SteeringDataCheckJoiner(const Mac::ExtAddress &aEui64) const;
Error SteeringDataCheckJoiner(const MeshCoP::JoinerDiscerner &aDiscerner) const;
Error GetServiceId(uint32_t aEnterpriseNumber,
const ServiceData &aServiceData,
bool aServerStable,
uint8_t &aServiceId) const;
Error GetPreferredNat64Prefix(ExternalRouteConfig &aConfig) const;
bool IsNat64(const Ip6::Address &aAddress) const;
#if OPENTHREAD_FTD
enum MatchMode : uint8_t
{
kMatchModeRloc16,
kMatchModeRouterId,
};
void Start(Mle::LeaderStartMode aStartMode);
void IncrementVersion(void);
void IncrementVersionAndStableVersion(void);
Error AnycastLookup(uint16_t aAloc16, uint16_t &aRloc16) const;
uint32_t GetContextIdReuseDelay(void) const { return mContextIds.GetReuseDelay(); }
void SetContextIdReuseDelay(uint32_t aDelay) { mContextIds.SetReuseDelay(aDelay); }
void RemoveBorderRouter(uint16_t aRloc16, MatchMode aMatchMode);
Error SetCommissioningData(const void *aData, uint8_t aDataLength);
void HandleNetworkDataRestoredAfterReset(void);
#endif
#if OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE
bool ContainsOmrPrefix(const Ip6::Prefix &aPrefix) const;
#endif
private:
using FilterIndexes = MeshCoP::SteeringData::HashBitIndexes;
typedef bool (&EntryChecker)(const BorderRouterEntry &aEntry);
const PrefixTlv *FindNextMatchingPrefixTlv(const Ip6::Address &aAddress, const PrefixTlv *aPrevTlv) const;
const PrefixTlv *FindPrefixTlvForContextId(uint8_t aContextId, const ContextTlv *&aContextTlv) const;
int CompareRouteEntries(const BorderRouterEntry &aFirst, const BorderRouterEntry &aSecond) const;
int CompareRouteEntries(const HasRouteEntry &aFirst, const HasRouteEntry &aSecond) const;
int CompareRouteEntries(const ServerTlv &aFirst, const ServerTlv &aSecond) const;
int CompareRouteEntries(int8_t aFirstPreference,
uint16_t aFirstRloc,
int8_t aSecondPreference,
uint16_t aSecondRloc) const;
static bool IsEntryDefaultRoute(const BorderRouterEntry &aEntry);
Error ExternalRouteLookup(uint8_t aDomainId, const Ip6::Address &aDestination, uint16_t &aRloc16) const;
Error DefaultRouteLookup(const PrefixTlv &aPrefix, uint16_t &aRloc16) const;
Error LookupRouteIn(const PrefixTlv &aPrefixTlv, EntryChecker aEntryChecker, uint16_t &aRloc16) const;
Error SteeringDataCheck(const FilterIndexes &aFilterIndexes) const;
void GetContextForMeshLocalPrefix(Lowpan::Context &aContext) const;
Error ReadCommissioningDataUint16SubTlv(MeshCoP::Tlv::Type aType, uint16_t &aValue) const;
void SignalNetDataChanged(void);
const CommissioningDataTlv *FindCommissioningData(void) const;
CommissioningDataTlv *FindCommissioningData(void) { return AsNonConst(AsConst(this)->FindCommissioningData()); }
const MeshCoP::Tlv *FindCommissioningDataSubTlv(uint8_t aType) const;
MeshCoP::Tlv *FindCommissioningDataSubTlv(uint8_t aType)
{
return AsNonConst(AsConst(this)->FindCommissioningDataSubTlv(aType));
}
#if OPENTHREAD_FTD
static constexpr uint32_t kMaxNetDataSyncWait = 60 * 1000;
static constexpr uint8_t kMinServiceId = 0x00;
static constexpr uint8_t kMaxServiceId = 0x0f;
class ChangedFlags
{
public:
ChangedFlags(void)
: mChanged(false)
, mStableChanged(false)
{
}
void Update(const NetworkDataTlv &aTlv)
{
mChanged = true;
mStableChanged = (mStableChanged || aTlv.IsStable());
}
bool DidChange(void) const { return mChanged; }
bool DidStableChange(void) const { return mStableChanged; }
private:
bool mChanged;
bool mStableChanged;
};
enum UpdateStatus : uint8_t
{
kTlvRemoved,
kTlvUpdated,
};
class ContextIds : public InstanceLocator
{
public:
static constexpr uint8_t kInvalidId = NumericLimits<uint8_t>::kMax;
explicit ContextIds(Instance &aInstance);
void Clear(void);
Error GetUnallocatedId(uint8_t &aId);
void MarkAsInUse(uint8_t aId) { mRemoveTimes[aId - kMinId].SetValue(kInUse); }
void ScheduleToRemove(uint8_t aId);
uint32_t GetReuseDelay(void) const { return mReuseDelay; }
void SetReuseDelay(uint32_t aDelay) { mReuseDelay = aDelay; }
void HandleTimer(void);
#if OPENTHREAD_CONFIG_BORDER_ROUTER_SIGNAL_NETWORK_DATA_FULL
void MarkAsClone(void) { mIsClone = true; }
#endif
private:
static constexpr uint32_t kReuseDelay = 5 * 60;
static constexpr uint8_t kMinId = 1;
static constexpr uint8_t kMaxId = 15;
static constexpr uint32_t kUnallocated = 0;
static constexpr uint32_t kInUse = 1;
bool IsUnallocated(uint8_t aId) const { return mRemoveTimes[aId - kMinId].GetValue() == kUnallocated; }
bool IsInUse(uint8_t aId) const { return mRemoveTimes[aId - kMinId].GetValue() == kInUse; }
TimeMilli GetRemoveTime(uint8_t aId) const { return mRemoveTimes[aId - kMinId]; }
void SetRemoveTime(uint8_t aId, TimeMilli aTime);
void MarkAsUnallocated(uint8_t aId) { mRemoveTimes[aId - kMinId].SetValue(kUnallocated); }
TimeMilli mRemoveTimes[kMaxId - kMinId + 1];
uint32_t mReuseDelay;
#if OPENTHREAD_CONFIG_BORDER_ROUTER_SIGNAL_NETWORK_DATA_FULL
bool mIsClone;
#endif
};
template <Uri kUri> void HandleTmf(Coap::Message &aMessage, const Ip6::MessageInfo &aMessageInfo);
void HandleTimer(void);
static bool IsEntryForDhcp6Agent(const BorderRouterEntry &aEntry);
static bool IsEntryForNdAgent(const BorderRouterEntry &aEntry);
Error LookupRouteForServiceAloc(uint16_t aAloc16, uint16_t &aRloc16) const;
Error LookupRouteForAgentAloc(uint8_t aContextId, EntryChecker aEntryChecker, uint16_t &aRloc16) const;
void RegisterNetworkData(uint16_t aRloc16, const NetworkData &aNetworkData);
Error AddPrefix(const PrefixTlv &aPrefix, ChangedFlags &aChangedFlags);
Error AddHasRoute(const HasRouteTlv &aHasRoute, PrefixTlv &aDstPrefix, ChangedFlags &aChangedFlags);
Error AddBorderRouter(const BorderRouterTlv &aBorderRouter, PrefixTlv &aDstPrefix, ChangedFlags &aChangedFlags);
Error AddService(const ServiceTlv &aService, ChangedFlags &aChangedFlags);
Error AddServer(const ServerTlv &aServer, ServiceTlv &aDstService, ChangedFlags &aChangedFlags);
Error AllocateServiceId(uint8_t &aServiceId) const;
const ServiceTlv *FindServiceById(uint8_t aServiceId) const;
void RemoveContext(uint8_t aContextId);
void RemoveContext(PrefixTlv &aPrefix, uint8_t aContextId);
void RemoveCommissioningData(void);
void RemoveRloc(uint16_t aRloc16, MatchMode aMatchMode, ChangedFlags &aChangedFlags);
void RemoveRloc(uint16_t aRloc16,
MatchMode aMatchMode,
const NetworkData &aExcludeNetworkData,
ChangedFlags &aChangedFlags);
void RemoveRlocInPrefix(PrefixTlv &aPrefix,
uint16_t aRloc16,
MatchMode aMatchMode,
const PrefixTlv *aExcludePrefix,
ChangedFlags &aChangedFlags);
void RemoveRlocInService(ServiceTlv &aService,
uint16_t aRloc16,
MatchMode aMatchMode,
const ServiceTlv *aExcludeService,
ChangedFlags &aChangedFlags);
void RemoveRlocInHasRoute(PrefixTlv &aPrefix,
HasRouteTlv &aHasRoute,
uint16_t aRloc16,
MatchMode aMatchMode,
const PrefixTlv *aExcludePrefix,
ChangedFlags &aChangedFlags);
void RemoveRlocInBorderRouter(PrefixTlv &aPrefix,
BorderRouterTlv &aBorderRouter,
uint16_t aRloc16,
MatchMode aMatchMode,
const PrefixTlv *aExcludePrefix,
ChangedFlags &aChangedFlags);
static bool RlocMatch(uint16_t aFirstRloc16, uint16_t aSecondRloc16, MatchMode aMatchMode);
static Error Validate(const NetworkData &aNetworkData, uint16_t aRloc16);
static Error ValidatePrefix(const PrefixTlv &aPrefix, uint16_t aRloc16);
static Error ValidateService(const ServiceTlv &aService, uint16_t aRloc16);
static bool ContainsMatchingEntry(const PrefixTlv *aPrefix, bool aStable, const HasRouteEntry &aEntry);
static bool ContainsMatchingEntry(const HasRouteTlv *aHasRoute, const HasRouteEntry &aEntry);
static bool ContainsMatchingEntry(const PrefixTlv *aPrefix, bool aStable, const BorderRouterEntry &aEntry);
static bool ContainsMatchingEntry(const BorderRouterTlv *aBorderRouter, const BorderRouterEntry &aEntry);
static bool ContainsMatchingServer(const ServiceTlv *aService, const ServerTlv &aServer);
UpdateStatus UpdatePrefix(PrefixTlv &aPrefix);
UpdateStatus UpdateService(ServiceTlv &aService);
UpdateStatus UpdateTlv(NetworkDataTlv &aTlv, const NetworkDataTlv *aSubTlvs);
Error UpdateCommissioningData(uint16_t aDataLength, CommissioningDataTlv *&aDataTlv);
Error SetCommissioningData(const Message &aMessage);
void SendCommissioningSetResponse(const Coap::Message &aRequest,
const Ip6::MessageInfo &aMessageInfo,
MeshCoP::StateTlv::State aState);
void IncrementVersions(bool aIncludeStable);
void IncrementVersions(const ChangedFlags &aFlags);
#if OPENTHREAD_CONFIG_BORDER_ROUTER_SIGNAL_NETWORK_DATA_FULL
void CheckForNetDataGettingFull(const NetworkData &aNetworkData, uint16_t aOldRloc16);
void MarkAsClone(void);
#endif
using UpdateTimer = TimerMilliIn<Leader, &Leader::HandleTimer>;
#endif
uint8_t mStableVersion;
uint8_t mVersion;
uint8_t mTlvBuffer[kMaxSize];
uint8_t mMaxLength;
#if OPENTHREAD_FTD
#if OPENTHREAD_CONFIG_BORDER_ROUTER_SIGNAL_NETWORK_DATA_FULL
bool mIsClone;
#endif
bool mWaitingForNetDataSync;
ContextIds mContextIds;
UpdateTimer mTimer;
#endif
};
Fields
Field
Declared as
UpdateTimer