Symbols ![]()
loading...
Files ![]()
loading...
ot::Ip6::Prefix class
Syntax
class Prefix : public otIp6Prefix, public Clearable<Prefix>, public Unequatable<Prefix>
{
public:
static constexpr uint8_t kMaxSize = OT_IP6_ADDRESS_SIZE;
static constexpr uint8_t kMaxLength = kMaxSize * kBitsPerByte;
static constexpr uint16_t kInfoStringSize = OT_IP6_PREFIX_STRING_SIZE;
typedef String<kInfoStringSize> InfoString;
const uint8_t *GetBytes(void) const { return mPrefix.mFields.m8; }
uint16_t GetSubnetId(void) const { return BigEndian::HostSwap16(mPrefix.mFields.m16[3]); }
uint8_t GetLength(void) const { return mLength; }
uint8_t GetBytesSize(void) const { return SizeForLength(mLength); }
void Set(const uint8_t *aPrefix, uint8_t aLength);
void Set(const NetworkPrefix &aNetworkPrefix) { Set(aNetworkPrefix.m8, NetworkPrefix::kLength); }
void SetSubnetId(uint16_t aSubnetId) { mPrefix.mFields.m16[3] = BigEndian::HostSwap16(aSubnetId); }
void SetLength(uint8_t aLength) { mLength = aLength; }
void Tidy(void);
bool IsValid(void) const { return (mLength <= kMaxLength); }
bool IsLinkLocal(void) const;
bool IsMulticast(void) const;
bool IsUniqueLocal(void) const;
bool IsEqual(const uint8_t *aPrefixBytes, uint8_t aPrefixLength) const;
bool ContainsPrefix(const Prefix &aSubPrefix) const;
bool ContainsPrefix(const NetworkPrefix &aSubPrefix) const;
bool operator==(const Prefix &aOther) const;
bool operator<(const Prefix &aOther) const;
static uint8_t SizeForLength(uint8_t aLength) { return BytesForBitSize(aLength); }
static uint8_t MatchLength(const uint8_t *aPrefixA, const uint8_t *aPrefixB, uint8_t aMaxSize);
static bool IsValidNat64PrefixLength(uint8_t aLength);
bool IsValidNat64(void) const { return IsValidNat64PrefixLength(mLength); }
Error FromString(const char *aString);
InfoString ToString(void) const;
void ToString(char *aBuffer, uint16_t aSize) const;
private:
uint8_t ByteAfterTidy(uint8_t aIndex);
void ToString(StringWriter &aWriter) const;
};
Fields
Related Functions
Found 64 other functions taking a Prefix
argument:
Function
Description
Indicates whether the IPv6 address matches a given prefix.
Copies the Prefix from TLV into a given `Ip6::Prefix`.
Indicates whether the prefix contains a sub-prefix.
Overloads operator `==` to evaluate whether or not two prefixes are equal.
Gets the prefix in this option.
Indicates whether the Prefix from TLV is equal to a given `Ip6::Prefix`.
Overloads operator `<` to compare two prefixes. If the two prefixes have the same length N, then the bytes are compared directly (as two big-endian N-bit numbers). If the two prefix have different lengths, the shorter prefix is padded by `0` bit up to the longer prefix length N before the bytes are compared (as big-endian N-bit numbers). If all bytes are equal, the prefix with shorter length is considered smaller.
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.
Sets the IPv6 address by performing NAT64 address translation from a given IPv4 address as specified in RFC 6052. The NAT64 @p aPrefix MUST have one of the following lengths: 32, 40, 48, 56, 64, or 96, otherwise the behavior of this method is undefined.
Sets the prefix.
Sets the prefix and adjusts the option length based on the prefix length.
Gets the prefix in this option.
Appends a Route Info Option to the RA message.
Set the prefix.
Indicates whether the address has a given prefix (i.e. same prefix length and matches the prefix).
Sets the ALOC.
Replaces a previously published external route. Only stable entries can be published (i.e.,`aConfig.mStable` MUST be `true`). If there is no previously published external route matching @p aPrefix, this method behaves similarly to `PublishExternalRoute()`, i.e., it will start the process of publishing @a aConfig as an external route in the Thread Network Data. If there is a previously published route entry matching @p aPrefix, it will be replaced with the new prefix from @p aConfig. - If the @p aPrefix was already added in the Network Data, the change to the new prefix in @p aConfig is immediately reflected in the Network Data. This ensures that route entries in the Network Data are not abruptly removed and the transition from aPrefix to the new prefix is smooth. - If the old published @p aPrefix was not added in the Network Data, it will be replaced with the new @p aConfig prefix but it will not be immediately added. Instead, it will start the process of publishing it in the Network Data (monitoring the Network Data to determine when/if to add the prefix, depending on the number of similar prefixes present in the Network Data).
Indicates whether or not currently a published prefix entry (on-mesh or external route) is added to the Thread Network Data.
Unpublishes a previously published prefix (on-mesh or external route).
Indicates whether or not the Thread Network Data contains a given on mesh prefix.
Removes an on-link prefix entry matching a given prefix.
Appends a Prefix Info Option to the RA message. The appended Prefix Info Option will have both on-link (L) and autonomous address-configuration (A) flags set.
Returns the local generated off-mesh-routable (OMR) prefix. The randomly generated 64-bit prefix will be added to the Thread Network Data if there isn't already an OMR prefix.
Indicates whether Network Data contains a valid OMR prefix. If the given @p aPrefix is itself not a valid OMR prefix, this method will return `false`, regardless of whether the prefix is present in the Network Data.
Finds and returns Domain ID associated with a given prefix in the Thread Network data.
Removes the local Domain Prefix configuration.
Processes the discovered NAT64 prefix.
Returns the currently favored off-mesh-routable (OMR) prefix. The favored OMR prefix can be discovered from Network Data or can be our local OMR prefix. An OMR prefix with higher preference is favored. If the preference is the same, then the smaller prefix (in the sense defined by `Ip6::Prefix`) is favored.
Returns the on-link prefix for the adjacent infrastructure link. The randomly generated 64-bit prefix will be advertised on the infrastructure link if there isn't already a usable on-link prefix being advertised on the link.
Returns the favored on-link prefix for the adjacent infrastructure link. The favored prefix is either a discovered prefix on the infrastructure link or the local on-link prefix.
Returns the local NAT64 prefix.
Returns the currently favored NAT64 prefix. The favored NAT64 prefix can be discovered from infrastructure link or can be the local NAT64 prefix.
Sets the prefix.
Removes a Border Router entry from the Thread Network Data.
Removes a Border Router entry from the Thread Network Data.
Informs `RoutingManager` of the result of the discovery request of NAT64 prefix on infrastructure interface (`InfraIf::DiscoverNat64Prefix()`).