Symbols

loading (2/5)...

Files

loading (4/5)...

Summary Syntax Methods References Class Tree Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFot::SupervisionListener

ot::SupervisionListener class

Implements a child supervision listener.

Syntax

Show:

Summary

Declaration

from child_supervision.hpp:135

class SupervisionListener : public InstanceLocator, private NonCopyable { public: explicit SupervisionListener(Instance &aInstance); void Start(void); void Stop(void); void SetInterval(uint16_t aInterval); uint16_t GetInterval(void) const { return mInterval; } void SetTimeout(uint16_t aTimeout); uint16_t GetTimeout(void) const { return mTimeout; } uint16_t GetCounter(void) const { return mCounter; } void ResetCounter(void) { mCounter = 0; } void UpdateOnReceive(const Mac::Address &aSourceAddress, bool aIsSecure); private: static constexpr uint16_t kDefaultTimeout = OPENTHREAD_CONFIG_CHILD_SUPERVISION_CHECK_TIMEOUT; static constexpr uint16_t kDefaultInterval = OPENTHREAD_CONFIG_CHILD_SUPERVISION_INTERVAL; void RestartTimer(void); void HandleTimer(void); using ListenerTimer = TimerMilliIn<SupervisionListener, &SupervisionListener::HandleTimer>; uint16_t mTimeout; uint16_t mInterval; uint16_t mCounter; ListenerTimer mTimer; };

Fields

Field

Declared as

ot::SupervisionListener::kDefaultTimeout

ot::SupervisionListener::kDefaultInterval

ot::SupervisionListener::mTimeout

uint16_t

ot::SupervisionListener::mInterval

uint16_t

ot::SupervisionListener::mCounter

uint16_t

ot::SupervisionListener::mTimer

ListenerTimer

Methods

Start()

Starts the supervision listener operation.

Stop()

Stops the supervision listener operation.

SetInterval()

Sets the supervision interval.

GetInterval() const

Returns the supervision interval.

SetTimeout()

Sets the supervision check timeout (in seconds). If the child does not hear from its parent within the given check timeout interval, it initiates the re-attach process (MLE Child Update Request/Response exchange with its parent). Setting the timeout to zero, disables the supervision check on the child. It is recommended to select a supervision check timeout value larger than the parent's child supervision interval plus the maximum time between the child's data poll transmissions.

GetTimeout() const

Returns the supervision check timeout interval (in seconds).

GetCounter() const

Returns the value of supervision check timeout failure counter. The counter tracks the number of supervision check failures on the child. It is incremented when the child does not hear from its parent within the specified check timeout interval.

ResetCounter()

Reset the supervision check timeout failure counter.

UpdateOnReceive()

Updates the supervision listener state. It informs the listener of a received frame.

RestartTimer()

HandleTimer()

References

Code

Location

Scope

Referrer

class SupervisionListener : public InstanceLocator, private NonCopyable

child_supervision.hpp:135

class SupervisionListener;

SupervisionListener::SupervisionListener(Instance &aInstance)

child_supervision.cpp:140

ot::SupervisionListener::SupervisionListener()

void SupervisionListener::Start(void) { RestartTimer(); }

child_supervision.cpp:149

ot::SupervisionListener::Start()

void SupervisionListener::Stop(void) { mTimer.Stop(); }

child_supervision.cpp:151

ot::SupervisionListener::Stop()

void SupervisionListener::SetInterval(uint16_t aInterval)

child_supervision.cpp:153

ot::SupervisionListener::SetInterval()

void SupervisionListener::SetTimeout(uint16_t aTimeout)

child_supervision.cpp:170

ot::SupervisionListener::SetTimeout()

void SupervisionListener::UpdateOnReceive(const Mac::Address &aSourceAddress, bool aIsSecure)

child_supervision.cpp:181

ot::SupervisionListener::UpdateOnReceive()

void SupervisionListener::RestartTimer(void)

child_supervision.cpp:194

ot::SupervisionListener::RestartTimer()

void SupervisionListener::HandleTimer(void)

child_supervision.cpp:206

ot::SupervisionListener::HandleTimer()

return AsCoreType(aInstance).Get<SupervisionListener>().GetInterval();

child_supervision_api.cpp:42

otChildSupervisionGetInterval()

AsCoreType(aInstance).Get<SupervisionListener>().SetInterval(aInterval);

child_supervision_api.cpp:47

otChildSupervisionSetInterval()

return AsCoreType(aInstance).Get<SupervisionListener>().GetTimeout();

child_supervision_api.cpp:52

otChildSupervisionGetCheckTimeout()

AsCoreType(aInstance).Get<SupervisionListener>().SetTimeout(aTimeout);

child_supervision_api.cpp:57

otChildSupervisionSetCheckTimeout()

return AsCoreType(aInstance).Get<SupervisionListener>().GetCounter();

child_supervision_api.cpp:62

otChildSupervisionGetCheckFailureCounter()

AsCoreType(aInstance).Get<SupervisionListener>().ResetCounter();

child_supervision_api.cpp:67

otChildSupervisionResetCheckFailureCounter()

SupervisionListener mSupervisionListener;

instance.hpp:632

ot::Instance::mSupervisionListener

template <> inline SupervisionListener &Instance::Get(void) { return mSupervisionListener; }

instance.hpp:970

ot::Instance::Get()

Get<SupervisionListener>().Stop();

mesh_forwarder.cpp:692

ot::MeshForwarder::SetRxOnWhenIdle()

Get<SupervisionListener>().Start();

mesh_forwarder.cpp:697

ot::MeshForwarder::SetRxOnWhenIdle()

Get<SupervisionListener>().UpdateOnReceive(rxInfo.mMacAddrs.mSource, rxInfo.IsLinkSecurityEnabled());

mesh_forwarder.cpp:1400

ot::MeshForwarder::HandleReceivedFrame()

friend class ot::SupervisionListener;

Call Tree

All items filtered out

All items filtered out

Data Use

All items filtered out

All items filtered out

Class Tree

ot::SupervisionListener is inherited by 2 classess:

ot::SupervisionListener

ot::NonCopyable

ot::InstanceLocator

Override Tree

All items filtered out

All items filtered out

Implementations

All items filtered out

All items filtered out

Instances

Instance

Scope

Location

Project

ot::Instance::mSupervisionListener

instance.hpp:632

return

ot::Instance::Get()

instance.hpp:970

Lifecycle

All items filtered out

All items filtered out