Symbols

loading (2/5)...

Files

loading (3/5)...

Summary Syntax Methods Related References Class Tree Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFot::Ip6::Netif

ot::Ip6::Netif class

Implements an IPv6 network interface.

Syntax

Show:

Summary

Declaration

from netif.hpp:72

class Netif : public InstanceLocator, private NonCopyable { friend class Ip6; friend class Address; public: enum AddressEvent : bool { kAddressRemoved = false, kAddressAdded = true, }; enum AddressOrigin : uint8_t { kOriginThread = OT_ADDRESS_ORIGIN_THREAD, kOriginSlaac = OT_ADDRESS_ORIGIN_SLAAC, kOriginDhcp6 = OT_ADDRESS_ORIGIN_DHCPV6, kOriginManual = OT_ADDRESS_ORIGIN_MANUAL, }; class UnicastAddress : public otNetifAddress, public LinkedListEntry<UnicastAddress>, public Clearable<UnicastAddress> { friend class LinkedList<UnicastAddress >; public: void InitAsThreadOrigin(void); void InitAsThreadOriginMeshLocal(void); void InitAsThreadOriginGlobalScope(void); void InitAsSlaacOrigin(uint8_t aPrefixLength, bool aPreferred); const Address &GetAddress(void) const { return AsCoreType(&mAddress); } Address &GetAddress(void) { return AsCoreType(&mAddress); } uint8_t GetPrefixLength(void) const { return mPrefixLength; } bool HasPrefix(const Prefix &aPrefix) const { return (mPrefixLength == aPrefix.GetLength()) && GetAddress().MatchesPrefix(aPrefix); } uint8_t GetScope(void) const { return mScopeOverrideValid ? static_cast<uint8_t>(mScopeOverride) : GetAddress().GetScope(); } void SetScopeOverride(uint8_t aScope) { mScopeOverride = aScope; mScopeOverrideValid = true; } AddressOrigin GetOrigin(void) const { return static_cast<AddressOrigin>(mAddressOrigin); } const UnicastAddress *GetNext(void) const { return static_cast<const UnicastAddress *>(mNext); } UnicastAddress *GetNext(void) { return static_cast<UnicastAddress *>(AsNonConst(mNext)); } private: bool Matches(const Address &aAddress) const { return GetAddress() == aAddress; } }; class MulticastAddress : public otNetifMulticastAddress, public LinkedListEntry<MulticastAddress>, public Clearable<MulticastAddress> { friend class LinkedList<MulticastAddress >; public: const Address &GetAddress(void) const { return AsCoreType(&mAddress); } Address &GetAddress(void) { return AsCoreType(&mAddress); } const MulticastAddress *GetNext(void) const { return static_cast<const MulticastAddress *>(mNext); } MulticastAddress *GetNext(void) { return static_cast<MulticastAddress *>(AsNonConst(mNext)); } private: bool Matches(const Address &aAddress) const { return GetAddress() == aAddress; } }; class ExternalMulticastAddress : public MulticastAddress { friend class Netif; friend class LinkedList<ExternalMulticastAddress >; public: class Iterator : public ItemPtrIterator<ExternalMulticastAddress, Iterator> { friend class ItemPtrIterator<ExternalMulticastAddress, Iterator >; friend class Netif; public: explicit Iterator(const Netif &aNetif, Address::TypeFilter aFilter = Address::kTypeAny); private: class Builder { public: Builder(const Netif &aNetif, Address::TypeFilter aFilter) : mNetif(aNetif) , mFilter(aFilter) { } Iterator begin(void) { return Iterator(mNetif, mFilter); } Iterator end(void) { return Iterator(mNetif, Iterator::kEndIterator); } private: const Netif &mNetif; Address::TypeFilter mFilter; }; enum IteratorType : uint8_t { kEndIterator, }; Iterator(const Netif &aNetif, IteratorType) : mNetif(aNetif) { } void AdvanceFrom(const MulticastAddress *aAddr); void Advance(void) { AdvanceFrom(mItem->GetNext()); } const Netif &mNetif; Address::TypeFilter mFilter; }; #if OPENTHREAD_CONFIG_MLR_ENABLE MlrState GetMlrState(void) const { return mMlrState; } void SetMlrState(MlrState aState) { mMlrState = aState; } #endif private: ExternalMulticastAddress *GetNext(void) { return static_cast<ExternalMulticastAddress *>(AsNonConst(mNext)); } #if OPENTHREAD_CONFIG_MLR_ENABLE MlrState mMlrState; #endif }; explicit Netif(Instance &aInstance); void SetAddressCallback(otIp6AddressCallback aCallback, void *aCallbackContext) { mAddressCallback.Set(aCallback, aCallbackContext); } const LinkedList<UnicastAddress> &GetUnicastAddresses(void) const { return mUnicastAddresses; } LinkedList<UnicastAddress> &GetUnicastAddresses(void) { return mUnicastAddresses; } void AddUnicastAddress(UnicastAddress &aAddress); void RemoveUnicastAddress(UnicastAddress &aAddress); void UpdatePreferredFlagOn(UnicastAddress &aAddress, bool aPreferred); bool HasUnicastAddress(const Address &aAddress) const; bool HasUnicastAddress(const UnicastAddress &aAddress) const { return mUnicastAddresses.Contains(aAddress); } bool IsUnicastAddressExternal(const UnicastAddress &aAddress) const; Error AddExternalUnicastAddress(const UnicastAddress &aAddress); Error RemoveExternalUnicastAddress(const Address &aAddress); void RemoveAllExternalUnicastAddresses(void); bool IsMulticastSubscribed(const Address &aAddress) const; void SubscribeAllRoutersMulticast(void); void UnsubscribeAllRoutersMulticast(void); const LinkedList<MulticastAddress> &GetMulticastAddresses(void) const { return mMulticastAddresses; } bool IsMulticastAddressExternal(const MulticastAddress &aAddress) const; void SubscribeMulticast(MulticastAddress &aAddress); void UnsubscribeMulticast(const MulticastAddress &aAddress); Error SubscribeExternalMulticast(const Address &aAddress); Error UnsubscribeExternalMulticast(const Address &aAddress); void UnsubscribeAllExternalMulticastAddresses(void); ExternalMulticastAddress::Iterator::Builder IterateExternalMulticastAddresses( Address::TypeFilter aFilter = Address::kTypeAny) { return ExternalMulticastAddress::Iterator::Builder(*this, aFilter); } bool HasAnyExternalMulticastAddress(void) const { return !ExternalMulticastAddress::Iterator(*this).IsDone(); } void ApplyNewMeshLocalPrefix(void); protected: void SubscribeAllNodesMulticast(void); void UnsubscribeAllNodesMulticast(void); private: typedef otIp6AddressInfo AddressInfo; static constexpr uint8_t kMulticastPrefixLength = 128; void SignalUnicastAddressChange(AddressEvent aEvent, const UnicastAddress &aAddress); void SignalMulticastAddressChange(AddressEvent aEvent, const MulticastAddress &aAddress, AddressOrigin aOrigin); void SignalMulticastAddressesChange(AddressEvent aEvent, const MulticastAddress *aStart, const MulticastAddress *aEnd); LinkedList<UnicastAddress> mUnicastAddresses; LinkedList<MulticastAddress> mMulticastAddresses; Callback<otIp6AddressCallback> mAddressCallback; Pool<UnicastAddress, OPENTHREAD_CONFIG_IP6_MAX_EXT_UCAST_ADDRS> mExtUnicastAddressPool; Pool<ExternalMulticastAddress, OPENTHREAD_CONFIG_IP6_MAX_EXT_MCAST_ADDRS> mExtMulticastAddressPool; static const otNetifMulticastAddress kRealmLocalAllMplForwardersMulticastAddress; static const otNetifMulticastAddress kLinkLocalAllNodesMulticastAddress; static const otNetifMulticastAddress kRealmLocalAllNodesMulticastAddress; static const otNetifMulticastAddress kLinkLocalAllRoutersMulticastAddress; static const otNetifMulticastAddress kRealmLocalAllRoutersMulticastAddress; };

Fields

Methods

SetAddressCallback()

Registers a callback to notify internal IPv6 address changes.

GetUnicastAddresses() const

Returns the linked list of unicast addresses.

GetUnicastAddresses()

Returns the linked list of unicast addresses.

AddUnicastAddress()

Adds a unicast address to the network interface. Is intended for addresses internal to OpenThread. The @p aAddress instance is directly added in the unicast address linked list. If @p aAddress is already added, the call to `AddUnicastAddress()` with the same address will perform no action.

RemoveUnicastAddress()

Removes a unicast address from the network interface. Is intended for addresses internal to OpenThread. The @p aAddress instance is removed from the unicast address linked list. If @p aAddress is not in the list, the call to `RemoveUnicastAddress()` will perform no action.

UpdatePreferredFlagOn()

Updates the preferred flag on a previously added (internal to OpenThread core) unicast address. If the address is not added to the network interface or the current preferred flag of @p aAddress is the same as the given @p aPreferred, no action is performed.

HasUnicastAddress() const

Indicates whether or not an address is assigned to the interface.

HasUnicastAddress() const

Indicates whether or not an address is assigned to the interface.

IsUnicastAddressExternal() const

Indicates whether a unicast address is an external or internal address.

AddExternalUnicastAddress()

Adds an external (to OpenThread) unicast address to the network interface. For external address, the @p aAddress instance is not directly used (i.e., it can be temporary). It is copied into a local entry (allocated from an internal pool) before being added in the unicast address linked list. The maximum number of external addresses is specified by `OPENTHREAD_CONFIG_IP6_MAX_EXT_UCAST_ADDRS`.

RemoveExternalUnicastAddress()

Removes a external (to OpenThread) unicast address from the network interface.

RemoveAllExternalUnicastAddresses()

Removes all the previously added external (to OpenThread) unicast addresses from the network interface.

IsMulticastSubscribed() const

Indicates whether or not the network interface is subscribed to a multicast address.

SubscribeAllRoutersMulticast()

Subscribes the network interface to the link-local and realm-local all routers addresses.

UnsubscribeAllRoutersMulticast()

Unsubscribes the network interface to the link-local and realm-local all routers address.

GetMulticastAddresses() const

Returns the linked list of multicast addresses.

IsMulticastAddressExternal() const

Indicates whether a multicast address is an external or internal address.

SubscribeMulticast()

Subscribes the network interface to a multicast address. Is intended for addresses internal to OpenThread. The @p aAddress instance is directly added in the multicast address linked list.

UnsubscribeMulticast()

Unsubscribes the network interface to a multicast address. Is intended for addresses internal to OpenThread. The @p aAddress instance is directly removed from the multicast address linked list.

SubscribeExternalMulticast()

Subscribes the network interface to the external (to OpenThread) multicast address. For external address, the @p aAddress instance is not directly used (i.e., it can be temporary). It is copied into a local entry (allocated from an internal pool) before being added in the multicast address linked list. The maximum number of external addresses is specified by `OPENTHREAD_CONFIG_IP6_MAX_EXT_MCAST_ADDRS`.

UnsubscribeExternalMulticast()

Unsubscribes the network interface to the external (to OpenThread) multicast address.

UnsubscribeAllExternalMulticastAddresses()

Unsubscribes the network interface from all previously added external (to OpenThread) multicast addresses.

IterateExternalMulticastAddresses()

Enables range-based `for` loop iteration over external multicast addresses on the Netif that matches a given IPv6 address type filter. Should be used like follows: to iterate over all external multicast addresses for (Ip6::Netif::ExternalMulticastAddress &addr : Get().IterateExternalMulticastAddresses()) { ... } or to iterate over a subset of external multicast addresses determined by a given address type filter for (Ip6::Netif::ExternalMulticastAddress &addr : Get().IterateExternalMulticastAddresses(Ip6::Address::kTypeMulticastLargerThanRealmLocal)) { ... }.