Symbols

loading...

Files

loading (2/5)...

Summary Syntax Methods References

SourceVuESP-IDF Framework and ExamplesESP-IDFot::MeshCoP::DelayTimerTlv

ot::MeshCoP::DelayTimerTlv class

Defines Delay Timer TLV constants and types.

Syntax

Show:

Summary

Declaration

from meshcop_tlvs.hpp:551

class DelayTimerTlv : public UintTlvInfo<Tlv::kDelayTimer, uint32_t> { public: static constexpr uint32_t kMinDelay = OPENTHREAD_CONFIG_TMF_PENDING_DATASET_MINIMUM_DELAY; static constexpr uint32_t kMaxDelay = (72 * Time::kOneHourInMsec); static constexpr uint32_t kDefaultDelay = OPENTHREAD_CONFIG_TMF_PENDING_DATASET_DEFAULT_DELAY; static uint32_t CalculateRemainingDelay(const Tlv &aDelayTimerTlv, TimeMilli aUpdateTime); static_assert(kMinDelay <= kMaxDelay, "TMF_PENDING_DATASET_MINIMUM_DELAY is larger than max allowed"); static_assert(kDefaultDelay <= kMaxDelay, "TMF_PENDING_DATASET_DEFAULT_DELAY is larger than max allowed"); static_assert(kDefaultDelay >= kMinDelay, "TMF_PENDING_DATASET_DEFAULT_DELAY is smaller than min allowed"); };

Fields

Field

Description

ot::MeshCoP::DelayTimerTlv::kMinDelay

Minimum Delay Timer value (in msec).

ot::MeshCoP::DelayTimerTlv::kMaxDelay

Maximum Delay Timer value (in msec).

ot::MeshCoP::DelayTimerTlv::kDefaultDelay

Default Delay Timer value (in msec).

Methods

CalculateRemainingDelay()

Calculates the remaining delay in milliseconds, based on the value read from a Delay Timer TLV and the specified update time. Ensures that the calculated delay does not exceed `kMaxDelay`. Also accounts for time already elapsed since @p aUpdateTime. Caller MUST ensure that @p aDelayTimerTlv is a Delay Timer TLV, otherwise behavior is undefined.

References

Code

Location

Referrer

class DelayTimerTlv : public UintTlvInfo<Tlv::kDelayTimer, uint32_t>

meshcop_tlvs.hpp:551

aDatasetInfo.Set<kDelay>(cur->ReadValueAs<DelayTimerTlv>());

dataset.cpp:260

ot::MeshCoP::Dataset::ConvertTo() const

SuccessOrExit(error = Write<DelayTimerTlv>(aDatasetInfo.Get<kDelay>()));

dataset.cpp:434

ot::MeshCoP::Dataset::WriteTlvsFrom()

SuccessOrExit(aDataset.Read<DelayTimerTlv>(delay));

dataset_manager.cpp:942

ot::MeshCoP::PendingDatasetManager::StartDelayTimer()

delay = Min(delay, DelayTimerTlv::kMaxDelay);

dataset_manager.cpp:944

ot::MeshCoP::PendingDatasetManager::StartDelayTimer()

if (aInfo.mDataset.Read<DelayTimerTlv>(delayTimer) == kErrorNone)

dataset_manager_ftd.cpp:171

ot::MeshCoP::DatasetManager::ProcessSetOrReplaceRequest() const

delayTimer = Min(delayTimer, DelayTimerTlv::kMaxDelay);

dataset_manager_ftd.cpp:173

ot::MeshCoP::DatasetManager::ProcessSetOrReplaceRequest() const

if (aInfo.mAffectsNetworkKey && (delayTimer < DelayTimerTlv::kDefaultDelay))

dataset_manager_ftd.cpp:175

ot::MeshCoP::DatasetManager::ProcessSetOrReplaceRequest() const

delayTimer = DelayTimerTlv::kDefaultDelay;

dataset_manager_ftd.cpp:177

ot::MeshCoP::DatasetManager::ProcessSetOrReplaceRequest() const

IgnoreError(aInfo.mDataset.Write<DelayTimerTlv>(delayTimer));

dataset_manager_ftd.cpp:184

ot::MeshCoP::DatasetManager::ProcessSetOrReplaceRequest() const

SuccessOrExit(aDataset.Write<DelayTimerTlv>(Get<Leader>().GetDelayTimerMinimal()));

dataset_manager_ftd.cpp:414

ot::MeshCoP::PendingDatasetManager::ApplyActiveDataset()

, mDelayTimerMinimal(DelayTimerTlv::kMinDelay)

meshcop_leader.cpp:48

ot::MeshCoP::Leader::Leader()

VerifyOrExit((aDelayTimerMinimal != 0 && aDelayTimerMinimal < DelayTimerTlv::kMinDelay), error = kErrorInvalidArgs);

meshcop_leader.cpp:208

ot::MeshCoP::Leader::SetDelayTimerMinimal()

uint32_t DelayTimerTlv::CalculateRemainingDelay(const Tlv &aDelayTimerTlv, TimeMilli aUpdateTime)

meshcop_tlvs.cpp:105

ot::MeshCoP::DelayTimerTlv::CalculateRemainingDelay()

uint32_t delay = Min(aDelayTimerTlv.ReadValueAs<DelayTimerTlv>(), kMaxDelay);

meshcop_tlvs.cpp:107

ot::MeshCoP::DelayTimerTlv::CalculateRemainingDelay()