Symbols ![]()
loading...
Files ![]()
loading...
ot::Ip6::Netif::UnicastAddress class
Implements an IPv6 network interface unicast address.
Syntax
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; }
};
Related Functions
Found 11 other functions taking a UnicastAddress
argument:
Function
Description
Indicates whether a unicast address is an external or internal address.
Generates the IID of an IPv6 address.
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.
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.
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.
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`.
References
Code
Location
Scope
Referrer
Class Tree
ot::Ip6::Netif::UnicastAddress inherits 2 classess and is inherited by 1 classes:
Instances
Instance
Scope
Location
Project