Symbols

Files

Summary Syntax Methods References Class Tree Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFot::BorderRouter::InfraIf

ot::BorderRouter::InfraIf class

Represents the infrastructure network interface on a border router.

Syntax

Show:

Summary

Declaration

from infra_if.hpp:55

class InfraIf : public InstanceLocator { public: static constexpr uint16_t kInfoStringSize = 20; typedef String<kInfoStringSize> InfoString; typedef Data<kWithUint16Length> Icmp6Packet; typedef otPlatInfraIfLinkLayerAddress LinkLayerAddress; explicit InfraIf(Instance &aInstance); Error Init(uint32_t aIfIndex); void Deinit(void); bool IsInitialized(void) const { return mInitialized; } bool IsRunning(void) const { return mIsRunning; } uint32_t GetIfIndex(void) const { return mIfIndex; } void SetIfIndex(uint32_t aIfIndex) { mIfIndex = aIfIndex; } Error GetLinkLayerAddress(LinkLayerAddress &aLinkLayerAddress); bool HasAddress(const Ip6::Address &aAddress) const; Error Send(const Icmp6Packet &aPacket, const Ip6::Address &aDestination) const; void HandledReceived(uint32_t aIfIndex, const Ip6::Address &aSource, const Icmp6Packet &aPacket); Error DiscoverNat64Prefix(void) const; void DiscoverNat64PrefixDone(uint32_t aIfIndex, const Ip6::Prefix &aPrefix); Error HandleStateChanged(uint32_t aIfIndex, bool aIsRunning); InfoString ToString(void) const; private: bool mInitialized : 1; bool mIsRunning : 1; uint32_t mIfIndex; };

Fields

Field

Declared as

ot::BorderRouter::InfraIf::kInfoStringSize

ot::BorderRouter::InfraIf::mInitialized

bool : 1

ot::BorderRouter::InfraIf::mIsRunning

bool : 1

ot::BorderRouter::InfraIf::mIfIndex

uint32_t

Methods

Init()

Initializes the `InfraIf`.

Deinit()

Deinitilaizes the `InfraIf`.

IsInitialized() const

Indicates whether or not the `InfraIf` is initialized.

IsRunning() const

Indicates whether or not the infra interface is running.

GetIfIndex() const

Returns the infrastructure interface index.

SetIfIndex()

Sets the infrastructure interface index.

GetLinkLayerAddress()

Gets the infrastructure interface link-layer address.

HasAddress() const

Indicates whether or not the infra interface has the given IPv6 address assigned. MUST be used when interface is initialized.

Send() const

Sends an ICMPv6 Neighbor Discovery packet on the infrastructure interface. MUST be used when interface is initialized.

HandledReceived()

Processes a received ICMPv6 Neighbor Discovery packet from an infrastructure interface.

DiscoverNat64Prefix() const

Sends a request to discover the NAT64 prefix on the infrastructure interface.

DiscoverNat64PrefixDone()

Processes the discovered NAT64 prefix.

HandleStateChanged()

Handles infrastructure interface state changes.

ToString() const

Converts the `InfraIf` to a human-readable string.

References

Code

Location

Scope

Referrer

class InfraIf : public InstanceLocator

infra_if.hpp:55

InfraIf::InfraIf(Instance &aInstance)

infra_if.cpp:45

ot::BorderRouter::InfraIf::InfraIf()

Error InfraIf::Init(uint32_t aIfIndex)

infra_if.cpp:53

ot::BorderRouter::InfraIf::Init()

void InfraIf::Deinit(void)

infra_if.cpp:68

ot::BorderRouter::InfraIf::Deinit()

bool InfraIf::HasAddress(const Ip6::Address &aAddress) const

infra_if.cpp:77

ot::BorderRouter::InfraIf::HasAddress() const

Error InfraIf::Send(const Icmp6Packet &aPacket, const Ip6::Address &aDestination) const

infra_if.cpp:84

ot::BorderRouter::InfraIf::Send() const

void InfraIf::HandledReceived(uint32_t aIfIndex, const Ip6::Address &aSource, const Icmp6Packet &aPacket)

infra_if.cpp:91

ot::BorderRouter::InfraIf::HandledReceived()

Error InfraIf::DiscoverNat64Prefix(void) const

infra_if.cpp:109

ot::BorderRouter::InfraIf::DiscoverNat64Prefix() const

void InfraIf::DiscoverNat64PrefixDone(uint32_t aIfIndex, const Ip6::Prefix &aPrefix)

infra_if.cpp:120

ot::BorderRouter::InfraIf::DiscoverNat64PrefixDone()

Error InfraIf::GetLinkLayerAddress(LinkLayerAddress &aLinkLayerAddress)

infra_if.cpp:140

ot::BorderRouter::InfraIf::GetLinkLayerAddress()

Error InfraIf::HandleStateChanged(uint32_t aIfIndex, bool aIsRunning)

infra_if.cpp:145

ot::BorderRouter::InfraIf::HandleStateChanged()

InfraIf::InfoString InfraIf::ToString(void) const

infra_if.cpp:175

ot::BorderRouter::InfraIf::ToString() const

InfraIf::Icmp6Packet packet;

infra_if.cpp:191

ot::BorderRouter::otPlatInfraIfRecvIcmp6Nd()

AsCoreType(aInstance).Get<InfraIf>().HandledReceived(aInfraIfIndex, AsCoreType(aSrcAddress), packet);

infra_if.cpp:194

ot::BorderRouter::otPlatInfraIfRecvIcmp6Nd()

return AsCoreType(aInstance).Get<InfraIf>().HandleStateChanged(aInfraIfIndex, aIsRunning);

infra_if.cpp:199

ot::BorderRouter::otPlatInfraIfStateChanged()

AsCoreType(aInstance).Get<InfraIf>().DiscoverNat64PrefixDone(aInfraIfIndex, AsCoreType(aIp6Prefix));

infra_if.cpp:206

ot::BorderRouter::otPlatInfraIfDiscoverNat64PrefixDone()

template <> inline BorderRouter::InfraIf &Instance::Get(void) { return mRoutingManager.mInfraIf; }

instance.hpp:1064

ot::Instance

ot::Instance::Get()

void RoutingManager::HandleReceived(const InfraIf::Icmp6Packet &aPacket, const Ip6::Address &aSrcAddress)

routing_manager.cpp:390

ot::BorderRouter::RoutingManager::HandleReceived()

InfraIf::Icmp6Packet packet;

routing_manager.cpp:576

ot::BorderRouter::RoutingManager::SendRouterAdvertisement()

if (Get<InfraIf>().GetLinkLayerAddress(linkAddr) == kErrorNone)

routing_manager.cpp:612

ot::BorderRouter::RoutingManager::SendRouterAdvertisement()

void RoutingManager::HandleRouterSolicit(const InfraIf::Icmp6Packet &aPacket, const Ip6::Address &aSrcAddress)

routing_manager.cpp:706

ot::BorderRouter::RoutingManager::HandleRouterSolicit()

void RoutingManager::HandleNeighborAdvertisement(const InfraIf::Icmp6Packet &aPacket)

routing_manager.cpp:717

ot::BorderRouter::RoutingManager::HandleNeighborAdvertisement()

void RoutingManager::HandleRouterAdvertisement(const InfraIf::Icmp6Packet &aPacket, const Ip6::Address &aSrcAddress)

routing_manager.cpp:730

ot::BorderRouter::RoutingManager::HandleRouterAdvertisement()

InfraIf::Icmp6Packet packet;

routing_manager.cpp:1811

ot::BorderRouter::RoutingManager::RxRaTracker::SendNeighborSolicitToRouter()

if (Get<InfraIf>().GetLinkLayerAddress(linkAddr) == kErrorNone)

routing_manager.cpp:1821

ot::BorderRouter::RoutingManager::RxRaTracker::SendNeighborSolicitToRouter()

void RoutingManager::TxRaInfo::IncrementTxCountAndSaveHash(const InfraIf::Icmp6Packet &aRaMessage)

routing_manager.cpp:3736

ot::BorderRouter::RoutingManager::TxRaInfo::IncrementTxCountAndSaveHash()

InfraIf::Icmp6Packet packet;

routing_manager.cpp:3834

ot::BorderRouter::RoutingManager::RsSender::SendRs()

if (Get<InfraIf>().GetLinkLayerAddress(linkAddr) == kErrorNone)

routing_manager.cpp:3839

ot::BorderRouter::RoutingManager::RsSender::SendRs()

void HandleReceived(const InfraIf::Icmp6Packet &aPacket, const Ip6::Address &aSrcAddress);

routing_manager.hpp:408

using LinkLayerAddress = InfraIf::LinkLayerAddress;

routing_manager.hpp:654

void IncrementTxCountAndSaveHash(const InfraIf::Icmp6Packet &aRaMessage);

routing_manager.hpp:1402

void HandleRouterAdvertisement(const InfraIf::Icmp6Packet &aPacket, const Ip6::Address &aSrcAddress);

routing_manager.hpp:1538

void HandleRouterSolicit(const InfraIf::Icmp6Packet &aPacket, const Ip6::Address &aSrcAddress);

routing_manager.hpp:1539

void HandleNeighborAdvertisement(const InfraIf::Icmp6Packet &aPacket);

routing_manager.hpp:1540

InfraIf mInfraIf;

routing_manager.hpp:1570

ot::BorderRouter::RoutingManager

ot::BorderRouter::RoutingManager::mInfraIf

Call Tree

All items filtered out

Data Use

All items filtered out

Class Tree

ot::BorderRouter::InfraIf is inherited by 1 classes:

ot::BorderRouter::InfraIf

ot::InstanceLocator

Override Tree

All items filtered out

Implementations

All items filtered out

Instances

Instance

Scope

Location

Project

return

ot::Instance::Get()

instance.hpp:1064

ot::BorderRouter::RoutingManager::mInfraIf

ot::BorderRouter::RoutingManager

routing_manager.hpp:1570

Lifecycle

All items filtered out