ot::BackboneRouter::MulticastListenersTable class

Implements the definitions for Multicast Listeners Table.

Syntax

Show:

Summary

Declaration

from multicast_listeners_table.hpp:57

class MulticastListenersTable : public InstanceLocator, private NonCopyable { class IteratorBuilder; public: class Listener : public Clearable<Listener> { friend class MulticastListenersTable; public: typedef otBackboneRouterMulticastListenerCallback Callback; typedef otBackboneRouterMulticastListenerIterator Iterator; typedef otBackboneRouterMulticastListenerInfo Info; enum Event : uint8_t { kEventAdded = OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED, kEventRemoved = OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED, }; Listener(void) { Clear(); } const Ip6::Address &GetAddress(void) const { return mAddress; } const TimeMilli GetExpireTime(void) const { return mExpireTime; } private: void SetAddress(const Ip6::Address &aAddress) { mAddress = aAddress; } void SetExpireTime(TimeMilli aExpireTime) { mExpireTime = aExpireTime; } bool operator<(const Listener &aOther) const { return GetExpireTime() < aOther.GetExpireTime(); } Ip6::Address mAddress; TimeMilli mExpireTime; }; explicit MulticastListenersTable(Instance &aInstance) : InstanceLocator(aInstance) , mNumValidListeners(0) { } Error Add(const Ip6::Address &aAddress, TimeMilli aExpireTime); void Remove(const Ip6::Address &aAddress); void Expire(void); uint16_t Count(void) const { return mNumValidListeners; } IteratorBuilder Iterate(void) { return IteratorBuilder(GetInstance()); } void Clear(void); void SetCallback(Listener::Callback aCallback, void *aContext); Error GetNext(Listener::Iterator &aIterator, Listener::Info &aInfo); private: static constexpr uint16_t kTableSize = OPENTHREAD_CONFIG_MAX_MULTICAST_LISTENERS; static_assert(kTableSize >= 75, "Thread 1.2 Conformance requires table size of at least 75 listeners."); class IteratorBuilder : InstanceLocator { public: explicit IteratorBuilder(Instance &aInstance) : InstanceLocator(aInstance) { } Listener *begin(void); Listener *end(void); }; enum Action : uint8_t { kAdd, kRemove, kExpire, }; void Log(Action aAction, const Ip6::Address &aAddress, TimeMilli aExpireTime, Error aError) const; void FixHeap(uint16_t aIndex); bool SiftHeapElemDown(uint16_t aIndex); void SiftHeapElemUp(uint16_t aIndex); void CheckInvariants(void) const; Listener mListeners[kTableSize]; uint16_t mNumValidListeners; Callback<Listener::Callback> mCallback; };

Fields

Field

Declared as

ot::BackboneRouter::MulticastListenersTable::kTableSize

ot::BackboneRouter::MulticastListenersTable::mListeners

Listener[kTableSize]

ot::BackboneRouter::MulticastListenersTable::mNumValidListeners

uint16_t

ot::BackboneRouter::MulticastListenersTable::mCallback

Callback<Listener::Callback>

Methods

Add()

Remove()

Removes a given Multicast Listener.

Expire()

Removes expired Multicast Listeners.

Count() const

Counts the number of valid Multicast Listeners.

Iterate()

Enables range-based `for` loop iteration over all Multicast Listeners. Should be used as follows: for (MulticastListenersTable::Listener &listener : Get().Iterate()).