Symbols

Files

Summary Syntax Methods References Class Tree Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFot::ChildTable::IteratorBuilder

ot::ChildTable::IteratorBuilder class

Syntax

Show:

Summary

Declaration

Definition

from child_table.hpp:55

class IteratorBuilder; public: class Iterator : public InstanceLocator, public ItemPtrIterator<Child, Iterator> { friend class ItemPtrIterator<Child, Iterator >; friend class IteratorBuilder; public: Iterator(Instance &aInstance, Child::StateFilter aFilter); void Reset(void); Child *GetChild(void) { return mItem; } private: explicit Iterator(Instance &aInstance) : InstanceLocator(aInstance) , mFilter(Child::StateFilter::kInStateValid) { } void Advance(void); Child::StateFilter mFilter; }; explicit ChildTable(Instance &aInstance); void Clear(void); uint16_t GetChildIndex(const Child &aChild) const { return static_cast<uint16_t>(&aChild - mChildren); } Child *GetChildAtIndex(uint16_t aChildIndex); Child *GetNewChild(void); Child *FindChild(uint16_t aRloc16, Child::StateFilter aFilter); Child *FindChild(const Mac::ExtAddress &aExtAddress, Child::StateFilter aFilter); Child *FindChild(const Mac::Address &aMacAddress, Child::StateFilter aFilter); bool HasChildren(Child::StateFilter aFilter) const; uint16_t GetNumChildren(Child::StateFilter aFilter) const; uint16_t GetMaxChildren(void) const { return kMaxChildren; } uint16_t GetMaxChildrenAllowed(void) const { return mMaxChildrenAllowed; } Error SetMaxChildrenAllowed(uint16_t aMaxChildren); IteratorBuilder Iterate(Child::StateFilter aFilter) { return IteratorBuilder(GetInstance(), aFilter); } Error GetChildInfoById(uint16_t aChildId, Child::Info &aChildInfo); Error GetChildInfoByIndex(uint16_t aChildIndex, Child::Info &aChildInfo); void Restore(void); void RemoveStoredChild(const Child &aChild); Error StoreChild(const Child &aChild); bool HasMinimalChild(uint16_t aRloc16) const; bool HasSleepyChildWithAddress(const Ip6::Address &aIp6Address) const; bool Contains(const Neighbor &aNeighbor) const { const Child *child = static_cast<const Child *>(&aNeighbor); return (mChildren <= child) && (child < GetArrayEnd(mChildren)); } private: static constexpr uint16_t kMaxChildren = OPENTHREAD_CONFIG_MLE_MAX_CHILDREN; class IteratorBuilder : public InstanceLocator;

Implemented in child_table.hpp:312

Fields

Field

Declared as

ot::ChildTable::IteratorBuilder::mFilter

Child::StateFilter

Methods

begin()

end()

References

Code

Location

Scope

Referrer

class IteratorBuilder : public InstanceLocator

child_table.hpp:312

class IteratorBuilder;

child_table.hpp:55

friend class IteratorBuilder;

child_table.hpp:64

IteratorBuilder Iterate(Child::StateFilter aFilter) { return IteratorBuilder(GetInstance(), aFilter); }

child_table.hpp:231

ot::ChildTable

ot::ChildTable::Iterate()

Call Tree

All items filtered out

Data Use

All items filtered out

Class Tree

ot::ChildTable::IteratorBuilder is inherited by 1 classes:

ot::ChildTable::IteratorBuilder

ot::InstanceLocator

Override Tree

All items filtered out

Implementations

All items filtered out

Instances

Instance

Scope

Location

Project

return

ot::ChildTable::Iterate()

child_table.hpp:231

Lifecycle

All items filtered out