Symbols

loading...

Files

loading (3/5)...

Summary Syntax Methods References Class Tree Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFot::Notifier

ot::Notifier class

Implements the OpenThread Notifier. For core internal modules, `Notifier` class emits events directly to them by invoking method `HandleNotifierEvents()` on the module instance. A `otStateChangedCallback` callback can be explicitly registered with the `Notifier`. This is mainly intended for use by external users (i.e.provided as an OpenThread public API). Max number of such callbacks that can be registered at the same time is specified by `OPENTHREAD_CONFIG_MAX_STATECHANGE_HANDLERS` configuration parameter.

Syntax

Show:

Summary

Declaration

from notifier.hpp:187

class Notifier : public InstanceLocator, private NonCopyable { public: explicit Notifier(Instance &aInstance); Error RegisterCallback(otStateChangedCallback aCallback, void *aContext); void RemoveCallback(otStateChangedCallback aCallback, void *aContext); void Signal(Event aEvent); void SignalIfFirst(Event aEvent); bool IsPending(void) const { return !mEventsToSignal.IsEmpty(); } bool HasSignaled(Event aEvent) const { return mSignaledEvents.Contains(aEvent); } template <typename Type> Error Update(Type &aVariable, const Type &aNewValue, Event aEvent) { Error error = kErrorNone; if (aVariable == aNewValue) { SignalIfFirst(aEvent); error = kErrorAlready; } else { aVariable = aNewValue; Signal(aEvent); } return error; } private: static constexpr uint16_t kMaxExternalHandlers = OPENTHREAD_CONFIG_MAX_STATECHANGE_HANDLERS; static constexpr uint16_t kFlagsStringLineLimit = 70; static constexpr uint8_t kMaxFlagNameLength = 25; static constexpr uint16_t kFlagsStringBufferSize = kFlagsStringLineLimit + kMaxFlagNameLength; typedef Callback<otStateChangedCallback> ExternalCallback; void EmitEvents(void); void LogEvents(Events aEvents) const; const char *EventToString(Event aEvent) const; using EmitEventsTask = TaskletIn<Notifier, &Notifier::EmitEvents>; Events mEventsToSignal; Events mSignaledEvents; EmitEventsTask mTask; ExternalCallback mExternalCallbacks[kMaxExternalHandlers]; };

Fields

Field

Declared as

ot::Notifier::kMaxExternalHandlers

ot::Notifier::kFlagsStringLineLimit

ot::Notifier::kMaxFlagNameLength

ot::Notifier::kFlagsStringBufferSize

ot::Notifier::mEventsToSignal

ot::Notifier::mSignaledEvents

ot::Notifier::mTask

ot::Notifier::mExternalCallbacks

ExternalCallback[kMaxExternalHandlers]

Methods

RegisterCallback()

Registers an `otStateChangedCallback` handler.

RemoveCallback()

Removes/unregisters a previously registered `otStateChangedCallback` handler.

Signal()

Schedules signaling of an event.

SignalIfFirst()

Schedules signaling of am event only if the event has not been signaled before (first time signal).

IsPending() const

Indicates whether or not an event signal callback is pending/scheduled.

HasSignaled() const

Indicates whether or not an event has been signaled before.

Update()

EmitEvents()

LogEvents() const

EventToString() const

Update

References

Code

Location

Scope

Referrer

class Notifier : public InstanceLocator, private NonCopyable

notifier.hpp:187

friend class ot::Notifier;

announce_sender.hpp:193

Get<Notifier>().Signal(kEventThreadBackboneRouterLocalChanged);

bbr_local.cpp:108

ot::BackboneRouter::Local::Reset()

Get<Notifier>().Signal(kEventThreadBackboneRouterLocalChanged);

bbr_local.cpp:159

ot::BackboneRouter::Local::SetConfig()

Get<Notifier>().Signal(kEventThreadBackboneRouterStateChanged);

bbr_local.cpp:234

ot::BackboneRouter::Local::SetState()

Get<Notifier>().Signal(kEventThreadBackboneRouterLocalChanged);

bbr_local.cpp:271

ot::BackboneRouter::Local::HandleBackboneRouterPrimaryUpdate()

friend class ot::Notifier;

bbr_manager.hpp:63

friend class ot::Notifier;

border_agent.hpp:61

friend class ot::Notifier;

child_supervision.hpp:92

Get<Notifier>().Signal(IsActiveDataset() ? kEventActiveDatasetChanged : kEventPendingDatasetChanged);

dataset_manager.cpp:398

ot::MeshCoP::DatasetManager::SignalDatasetChange() const

friend class ot::Notifier;

dua_manager.hpp:83

friend class ot::Notifier;

energy_scan_server.hpp:55

Notifier mNotifier;

instance.hpp:479

ot::Instance::mNotifier

template <> inline Notifier &Instance::Get(void) { return mNotifier; }

instance.hpp:761

ot::Instance::Get()

return AsCoreType(aInstance).Get<Notifier>().RegisterCallback(aCallback, aContext);

instance_api.cpp:115

otSetStateChangedCallback()

AsCoreType(aInstance).Get<Notifier>().RemoveCallback(aCallback, aContext);

instance_api.cpp:120

otRemoveStateChangeCallback()

friend class ot::Notifier;

joiner_router.hpp:59

Get<Notifier>().Signal(kEventThreadKeySeqCounterChanged);

key_manager.cpp:277

ot::KeyManager::SetNetworkKey()

VerifyOrExit(aKeySequence != mKeySequence, Get<Notifier>().SignalIfFirst(kEventThreadKeySeqCounterChanged));

key_manager.cpp:367

ot::KeyManager::SetCurrentKeySequence()

Get<Notifier>().Signal(kEventThreadKeySeqCounterChanged);

key_manager.cpp:387

ot::KeyManager::SetCurrentKeySequence()

SuccessOrExit(Get<Notifier>().Update(mPanChannel, aChannel, kEventThreadChannelChanged));

ot::Mac::Mac::SetPanChannel()

SuccessOrExit(Get<Notifier>().Update(mPanId, aPanId, kEventThreadPanIdChanged));

ot::Mac::Mac::SetPanId()

Get<Notifier>().Signal(kEventParentLinkQualityChanged);

ot::Mac::Mac::UpdateNeighborLinkInfo()

SuccessOrExit(Get<Notifier>().Update(mRole, aRole, kEventThreadRoleChanged));

ot::Mle::Mle::SetRole()

Get<Notifier>().Signal(kEventThreadLinkLocalAddrChanged);

ot::Mle::Mle::UpdateLinkLocalAddress()

Get<Notifier>().Signal(kEventThreadMeshLocalAddrChanged);

ot::Mle::Mle::SetMeshLocalPrefix()

Get<Notifier>().Signal(kEventThreadPartitionIdChanged);

ot::Mle::Mle::SetLeaderData()

Get<Notifier>().SignalIfFirst(kEventThreadPartitionIdChanged);

ot::Mle::Mle::SetLeaderData()

Get<Notifier>().Signal(kEventThreadMeshLocalAddrChanged);

ot::Mle::Mle::HandleNotifierEvents()

if (Get<Notifier>().IsPending())

ot::Mle::Mle::HandleMessageTransmissionTimer()

friend class ot::Notifier;

friend class ot::Notifier;

mlr_manager.hpp:78

Get<Notifier>().Signal(kEventThreadChildAdded);

neighbor_table.cpp:308

ot::NeighborTable::Signal()

Get<Notifier>().Signal(kEventThreadChildRemoved);

neighbor_table.cpp:312

ot::NeighborTable::Signal()

Get<Notifier>().Signal(aEvent == kAddressAdded ? kEventIp6MulticastSubscribed : kEventIp6MulticastUnsubscribed);

ot::Ip6::Netif::SignalMulticastAddressChange()

Get<Notifier>().Signal(event);

ot::Ip6::Netif::SignalUnicastAddressChange()

Get<ot::Notifier>().Signal(kEventThreadNetdataChanged);

network_data_leader.cpp:689

ot::NetworkData::Leader::SignalNetDataChanged()

friend class ot::Notifier;

network_data_notifier.hpp:60

friend class ot::Notifier;

network_data_publisher.hpp:73

Get<Notifier>().Signal(kEventThreadNetworkNameChanged);

network_name.cpp:131

ot::MeshCoP::NetworkNameManager::SignalNetworkNameChange()

Get<Notifier>().SignalIfFirst(kEventThreadNetworkNameChanged);

network_name.cpp:135

ot::MeshCoP::NetworkNameManager::SignalNetworkNameChange()

Notifier::Notifier(Instance &aInstance)

notifier.cpp:42

ot::Notifier::Notifier()

Error Notifier::RegisterCallback(otStateChangedCallback aCallback, void *aContext)

notifier.cpp:52

ot::Notifier::RegisterCallback()

void Notifier::RemoveCallback(otStateChangedCallback aCallback, void *aContext)

notifier.cpp:77

ot::Notifier::RemoveCallback()

void Notifier::Signal(Event aEvent)

notifier.cpp:93

ot::Notifier::Signal()

void Notifier::SignalIfFirst(Event aEvent)

notifier.cpp:100

ot::Notifier::SignalIfFirst()

void Notifier::EmitEvents(void)

notifier.cpp:108

ot::Notifier::EmitEvents()

void Notifier::LogEvents(Events aEvents) const

notifier.cpp:201

ot::Notifier::LogEvents() const

const char *Notifier::EventToString(Event aEvent) const

notifier.cpp:234

ot::Notifier::EventToString() const

using EmitEventsTask = TaskletIn<Notifier, &Notifier::EmitEvents>;

notifier.hpp:299

friend class ot::Notifier;

routing_manager.hpp:98

friend class ot::Notifier;

slaac_address.hpp:64

friend class ot::Notifier;

srp_client.hpp:74

Get<Notifier>().Signal(kEventThreadNetifStateChanged);

thread_netif.cpp:71

ot::ThreadNetif::Up()

Get<Notifier>().Signal(kEventThreadNetifStateChanged);

thread_netif.cpp:105

ot::ThreadNetif::Down()

friend class ot::Notifier;

trel_link.hpp:72

Call Tree

All items filtered out

All items filtered out

Data Use

All items filtered out

All items filtered out

Class Tree

ot::Notifier is inherited by 2 classess:

ot::Notifier

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::mNotifier

instance.hpp:479

return

ot::Instance::Get()

instance.hpp:761

Lifecycle

All items filtered out

All items filtered out