Symbols

loading (4/5)...

Files

loading (4/5)...

Summary Syntax Methods Related References Class Tree Instances

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

ot::Ip6::InterfaceIdentifier class

Syntax

Show:

Summary

Declaration

from ip6_address.hpp:336

class InterfaceIdentifier : public otIp6InterfaceIdentifier, public Equatable<InterfaceIdentifier>, public Clearable<InterfaceIdentifier> { friend class Address; public: static constexpr uint8_t kSize = OT_IP6_IID_SIZE; static constexpr uint16_t kInfoStringSize = 17; typedef String<kInfoStringSize> InfoString; bool IsUnspecified(void) const; bool IsReserved(void) const; bool IsSubnetRouterAnycast(void) const; bool IsReservedSubnetAnycast(void) const; void GenerateRandom(void); const uint8_t *GetBytes(void) const { return mFields.m8; } void SetBytes(const uint8_t *aBuffer); void SetFromExtAddress(const Mac::ExtAddress &aExtAddress); void ConvertToExtAddress(Mac::ExtAddress &aExtAddress) const; void ConvertToMacAddress(Mac::Address &aMacAddress) const; void SetToLocator(uint16_t aLocator); bool IsLocator(void) const; bool IsRoutingLocator(void) const; bool IsAnycastLocator(void) const; bool IsAnycastServiceLocator(void) const; uint16_t GetLocator(void) const { return BigEndian::HostSwap16(mFields.m16[3]); } void SetLocator(uint16_t aLocator) { mFields.m16[3] = BigEndian::HostSwap16(aLocator); } void ApplyPrefix(const Prefix &aPrefix); InfoString ToString(void) const; private: static constexpr uint8_t kAloc16Mask = 0xfc; static constexpr uint8_t kRloc16ReservedBitMask = 0x02; };

Fields

Field

ot::Ip6::InterfaceIdentifier::kSize

ot::Ip6::InterfaceIdentifier::kInfoStringSize

ot::Ip6::InterfaceIdentifier::kAloc16Mask

ot::Ip6::InterfaceIdentifier::kRloc16ReservedBitMask

Methods

IsUnspecified() const

Indicates whether or not the Interface Identifier is unspecified.

IsReserved() const

Indicates whether or not the Interface Identifier is reserved (RFC 5453).

IsSubnetRouterAnycast() const

Indicates whether or not the Interface Identifier is Subnet-Router Anycast (RFC 4291).

IsReservedSubnetAnycast() const

Indicates whether or not the Interface Identifier is Reserved Subnet Anycast (RFC 2526).

GenerateRandom()

Generates and sets the Interface Identifier to a crypto-secure random byte sequence.

GetBytes() const

Gets the Interface Identifier as a pointer to a byte array.

SetBytes()

Sets the Interface Identifier from a given byte array.

SetFromExtAddress()

Sets the Interface Identifier from a given IEEE 802.15.4 Extended Address.

ConvertToExtAddress() const

Converts the Interface Identifier to an IEEE 802.15.4 Extended Address.

ConvertToMacAddress() const

Converts the Interface Identifier to an IEEE 802.15.4 MAC Address.

SetToLocator()

Sets the Interface Identifier to Routing/Anycast Locator pattern `0000:00ff:fe00:xxxx` with a given locator (RLOC16 or ALOC16) value.

IsLocator() const

Indicates whether or not the Interface Identifier matches the locator pattern `0000:00ff:fe00:xxxx`.

IsRoutingLocator() const

Indicates whether or not the Interface Identifier (IID) matches a Routing Locator (RLOC). In addition to checking that the IID matches the locator pattern (`0000:00ff:fe00:xxxx`), this method also checks that the locator value is a valid RLOC16.

IsAnycastLocator() const

Indicates whether or not the Interface Identifier (IID) matches an Anycast Locator (ALOC). In addition to checking that the IID matches the locator pattern (`0000:00ff:fe00:xxxx`), this method also checks that the locator value is any valid ALOC16 (0xfc00 - 0xfcff).

IsAnycastServiceLocator() const

Indicates whether or not the Interface Identifier (IID) matches a Service Anycast Locator (ALOC). In addition to checking that the IID matches the locator pattern (`0000:00ff:fe00:xxxx`), this method also checks that the locator value is a valid Service ALOC16 (0xfc10 – 0xfc2f).

GetLocator() const

Gets the Interface Identifier (IID) address locator fields. Assumes the IID to match the locator pattern `0000:00ff:fe00:xxxx` (does not explicitly check this) and returns the last `uint16` portion of the IID.

SetLocator()

Sets the Interface Identifier (IID) address locator field. Unlike `SetToLocator()`, this method only changes the last 2 bytes of the IID and keeps the rest of the address as before.

ApplyPrefix()

Applies a prefix to IID. If the prefix length is longer than 64 bits, the prefix bits after 64 are written into the IID. This method only changes the bits in IID up the prefix length and keeps the rest of the bits in IID as before.

ot::Ip6::InterfaceIdentifier class

Syntax

Fields

Methods

IsUnspecified() const

IsReserved() const

IsSubnetRouterAnycast() const

IsReservedSubnetAnycast() const

GenerateRandom()

GetBytes() const

SetBytes()

SetFromExtAddress()

ConvertToExtAddress() const

ConvertToMacAddress() const

SetToLocator()

IsLocator() const

IsRoutingLocator() const

IsAnycastLocator() const

IsAnycastServiceLocator() const

GetLocator() const

SetLocator()

ApplyPrefix()

ToString() const

Related Functions

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle