Symbols ![]()
loading...
Files ![]()
loading...
ot::Ip6::Address class
Syntax
class Address : public otIp6Address, public Equatable<Address>, public Clearable<Address>
{
friend class Prefix;
friend class InterfaceIdentifier;
public:
static constexpr uint8_t kAloc16Mask = InterfaceIdentifier::kAloc16Mask;
static constexpr uint8_t kSize = OT_IP6_ADDRESS_SIZE;
static constexpr uint16_t kInfoStringSize = OT_IP6_ADDRESS_STRING_SIZE;
static constexpr uint8_t kNodeLocalScope = 0;
static constexpr uint8_t kInterfaceLocalScope = 1;
static constexpr uint8_t kLinkLocalScope = 2;
static constexpr uint8_t kRealmLocalScope = 3;
static constexpr uint8_t kAdminLocalScope = 4;
static constexpr uint8_t kSiteLocalScope = 5;
static constexpr uint8_t kOrgLocalScope = 8;
static constexpr uint8_t kGlobalScope = 14;
enum TypeFilter : uint8_t
{
kTypeAny,
kTypeUnicast,
kTypeMulticast,
kTypeMulticastLargerThanRealmLocal,
};
typedef String<kInfoStringSize> InfoString;
const uint8_t *GetBytes(void) const { return mFields.m8; }
void SetBytes(const uint8_t *aBuffer) { memcpy(mFields.m8, aBuffer, kSize); }
bool IsUnspecified(void) const;
bool IsLoopback(void) const;
bool IsLinkLocalUnicast(void) const;
void SetToLinkLocalAddress(const Mac::ExtAddress &aExtAddress);
void SetToLinkLocalAddress(const InterfaceIdentifier &aIid);
bool IsMulticast(void) const { return mFields.m8[0] == 0xff; }
bool IsLinkLocalMulticast(void) const;
bool IsLinkLocalUnicastOrMulticast(void) const;
bool IsLinkLocalAllNodesMulticast(void) const;
void SetToLinkLocalAllNodesMulticast(void);
bool IsLinkLocalAllRoutersMulticast(void) const;
void SetToLinkLocalAllRoutersMulticast(void);
bool IsRealmLocalMulticast(void) const;
bool IsRealmLocalAllNodesMulticast(void) const;
void SetToRealmLocalAllNodesMulticast(void);
bool IsRealmLocalAllRoutersMulticast(void) const;
void SetToRealmLocalAllRoutersMulticast(void);
bool IsRealmLocalAllMplForwarders(void) const;
void SetToRealmLocalAllMplForwarders(void);
bool IsMulticastLargerThanRealmLocal(void) const;
void SetToRoutingLocator(const NetworkPrefix &aNetworkPrefix, uint16_t aRloc16)
{
SetToLocator(aNetworkPrefix, aRloc16);
}
void SetToAnycastLocator(const NetworkPrefix &aNetworkPrefix, uint16_t aAloc16)
{
SetToLocator(aNetworkPrefix, aAloc16);
}
bool IsIp4Mapped(void) const;
void SetToIp4Mapped(const Ip4::Address &aIp4Address);
const NetworkPrefix &GetPrefix(void) const
{
return static_cast<const NetworkPrefix &>(mFields.mComponents.mNetworkPrefix);
}
void GetPrefix(uint8_t aLength, Prefix &aPrefix) const { aPrefix.Set(mFields.m8, aLength); }
bool MatchesPrefix(const Prefix &aPrefix) const;
bool MatchesPrefix(const uint8_t *aPrefix, uint8_t aPrefixLength) const;
void SetPrefix(const uint8_t *aPrefix, uint8_t aPrefixLength) { CopyBits(mFields.m8, aPrefix, aPrefixLength); }
void SetPrefix(const NetworkPrefix &aNetworkPrefix);
void SetPrefix(const Prefix &aPrefix);
void SetMulticastNetworkPrefix(const uint8_t *aPrefix, uint8_t aPrefixLength);
void SetMulticastNetworkPrefix(const NetworkPrefix &aNetworkPrefix)
{
SetMulticastNetworkPrefix(aNetworkPrefix.m8, NetworkPrefix::kLength);
}
void SetMulticastNetworkPrefix(const Prefix &aPrefix)
{
SetMulticastNetworkPrefix(aPrefix.GetBytes(), aPrefix.GetLength());
}
const InterfaceIdentifier &GetIid(void) const
{
return static_cast<const InterfaceIdentifier &>(mFields.mComponents.mIid);
}
InterfaceIdentifier &GetIid(void) { return static_cast<InterfaceIdentifier &>(mFields.mComponents.mIid); }
void SetIid(const InterfaceIdentifier &aIid) { GetIid() = aIid; }
uint8_t GetScope(void) const;
uint8_t PrefixMatch(const Address &aOther) const;
bool MatchesFilter(TypeFilter aFilter) const;
void SynthesizeFromIp4Address(const Prefix &aPrefix, const Ip4::Address &aIp4Address);
Error FromString(const char *aString);
InfoString ToString(void) const;
void ToString(char *aBuffer, uint16_t aSize) const;
bool operator<(const Address &aOther) const { return memcmp(mFields.m8, aOther.mFields.m8, sizeof(Address)) < 0; }
private:
static constexpr uint8_t kMulticastNetworkPrefixLengthOffset = 3;
static constexpr uint8_t kMulticastNetworkPrefixOffset = 4;
void SetToLocator(const NetworkPrefix &aNetworkPrefix, uint16_t aLocator);
void ToString(StringWriter &aWriter) const;
void AppendHexWords(StringWriter &aWriter, uint8_t aLength) const;
static const Address &GetLinkLocalAllNodesMulticast(void);
static const Address &GetLinkLocalAllRoutersMulticast(void);
static const Address &GetRealmLocalAllNodesMulticast(void);
static const Address &GetRealmLocalAllRoutersMulticast(void);
static const Address &GetRealmLocalAllMplForwarders(void);
static void CopyBits(uint8_t *aDst, const uint8_t *aSrc, uint8_t aNumBits);
Error ParseFrom(const char *aString, char aTerminatorChar);
};
Fields
Field
Related Functions
Found 161 other functions taking a Address
argument:
Function
Description
Sets the peer's socket address.
Sets the local socket address.
Retrieves the Domain Unicast Address registered by the child.
Sets the IPv6 Source address.
Retrieves the Service ALOC for given Service ID.
Calculates and then updates the checksum in a given message (if TCP/UDP/ICMPv6).
Clears requests with specified source address used by this CoAP agent.
Gets the mesh-local IPv6 address.
Indicates whether or not a message meets TMF addressing rules. A TMF message MUST comply with following rules: - The destination port is `Tmf::kUdpPort`. - Both source and destination addresses are Link-Local, or - Source is Mesh Local and then destination is Mesh Local or Link-Local Multicast or Realm-Local Multicast.
Indicates whether or not an IPv6 address is an RLOC.
Indicates whether or not an IPv6 address is a Mesh Local Address.
Indicates whether or not an address is assigned to the interface.
Sets the IPv4 address from a given IPv4-mapped IPv6 address.
Iterates over all registered IPv6 addresses (using an iterator).
Adds an IPv6 address to the list.
Removes an IPv6 address from the list.
Indicates whether an IPv6 address is in the list of IPv6 addresses of the child.
Retrieves the 6LoWPAN Context information based on a given IPv6 address.
Indicates whether or not the infra interface has the given IPv6 address assigned. MUST be used when interface is initialized.
Sends an ICMPv6 Neighbor Discovery packet on the infrastructure interface. MUST be used when interface is initialized.
Sets the server IPv6 address.
Sets the IPv6 address.
Sets the Target Address field.
Sets the IPv6 address of the resource record.
Sets the IPv6 Destination address.
Subscribes the Backbone TMF socket to a given IPv6 multicast group on the Backbone network.
Indicates whether or not an IPv6 address is an ALOC.
Sends an Address Notification (ADDR_NTF.ans) message.
Sends an Address Error Notification (ADDR_ERR.ntf) message.
Removes a external (to OpenThread) unicast address from the network interface.
Indicates whether or not the network interface is subscribed to a multicast address.
Unsubscribes the network interface to the external (to OpenThread) multicast address.
Indicates whether or not the ICMPv6 Echo Request should be handled.
Send a Proactive Backbone Notification (PRO_BB.ntf) on the Backbone link.
Requests "DNS/SRP Service Unicast Address" to be published in the Thread Network Data. A call to this method will remove and replace any previous "DNS/SRP Service" entry that was being published (from earlier call to any of `PublishDnsSrpService{Type}()` methods). Publishes the "DNS/SRP Service Unicast Address" by including the address and port info in the Service TLV data.
Gets the IPv6 address associated with an address resolution DNS response. MUST only be used from `AddressCallback`. The response may include multiple IPv6 address records. @p aIndex can be used to iterate through the list of addresses. Index zero gets the the first address and so on. When we reach end of the list, this method returns `kErrorNotFound`.
Gets the host IPv6 address from a DNS browse (service instance enumeration) response. MUST only be used from `BrowseCallback`. The response can include zero or more IPv6 address records. @p aIndex can be used to iterate through the list of addresses. Index zero gets the first address and so on. When we reach end of the list, this method returns `kErrorNotFound`.
Gets the host IPv6 address from a DNS service instance resolution response. MUST only be used from `ServiceCallback`. The response can include zero or more IPv6 address records. @p aIndex can be used to iterate through the list of addresses. Index zero gets the first address and so on. When we reach end of the list, this method returns `kErrorNotFound`.
Sets/updates the list of host IPv6 address. Host IPv6 addresses can be set/changed before start or even during operation of SRP client (e.g. to add/remove or change a previously registered host address), except when the host info is being removed (client is busy handling a remove request from an earlier call to `RemoveHostAndServices()` and host info still being in either `kStateToRemove` or `kStateRemoving` states). After a successful call to this method, `Callback` will be called to report the status of the address registration with SRP server. Calling this method disables auto host address mode if it was previously enabled from a successful call to `EnableAutoHostAddress()`.
Unsubscribes the Backbone TMF socket from a given IPv6 multicast group on the Backbone network.
Indicates whether or not the address is a Domain Unicast Address.
Retrieves the Leader's RLOC.
Retrieves the Leader's ALOC.
Retrieves the Commissioner's ALOC for a given session ID.
Returns the number of IPv6 prefix bits that match.
Removes the cache entry for the EID.
Updates an existing entry or adds a snooped cache entry for a given EID. The method is intended to add an entry for snoop optimization (inspection of a received message to create a cache entry mapping an EID to a RLOC).
Looks up the RLOC16 for a given EID in the address cache. When a cache entry is successfully looked up using this method, it will be marked as "cached and in-use". Specifically, a snooped entry (`kStateSnooped`) will be marked as cached (`kStateCached`).
Is called by the address resolver when an EID-to-RLOC mapping has been resolved.
Sends Diagnostic Get request. If the @p aDestination is of multicast type, the DIAG_GET.qry message is sent or the DIAG_GET.req otherwise.
Sends Diagnostic Reset request.
Searches in the list of deprecating SLAAC prefixes for a match to a given address and if found, returns the Domain ID from the Prefix TLV in the Network Data for this SLAAC prefix. The `Slaac` module keeps track of the associated Domain IDs for deprecating SLAAC prefixes, even if the related Prefix TLV has already been removed from the Network Data. This information is used during external route lookup if a deprecating SLAAC address is used as the source address in an outbound message.
Sends a MGMT_DATASET_CHANGED message to commissioner.
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`.
Configures the UDP socket to join a multicast group on a Host network interface.
Configures the UDP socket to leave a multicast group on a Host network interface.
Sets the IPv4 address by performing NAT64 address translation from a given IPv6 address as specified in RFC 6052. The NAT64 @p aPrefixLength MUST be one of the following values: 32, 40, 48, 56, 64, or 96, otherwise the behavior of this method is undefined.
Initializes the MPL option.
Processes an MPL option. When the MPL module acts as an MPL Forwarder it disseminates MPL Data Message using Trickle timer expirations. When acts as an MPL Seed it allows to send the first MPL Data Message directly, then sets up Trickle timer expirations for subsequent retransmissions.
Initializes the CoAP header as `kCodePost` with a given URI Path with its type determined from a given destination IPv6 address.
Iterates through the discovered IPv6 address of a router.
Returns if the Child has IPv6 address @p aAddress of MLR state `kMlrStateRegistered`.
Indicates whether the child table contains any sleepy child (in states valid or restoring) with a given IPv6 address.
Indicates whether or not the given IPv6 address is on-mesh.
Performs a route lookup using the Network Data.
Indicates whether or not the given IPv6 address matches any NAT64 prefixes.
Removes a given Multicast Listener.
Gets the ND Proxy info for a given Domain Unicast Address.
Retrieves the ND Proxy info of the Domain Unicast Address.
Returns if messages destined to a given Domain Unicast Address should be forwarded to the Backbone link.
Sends BB.qry on the Backbone link.
Processes a received ICMPv6 Neighbor Discovery packet from an infrastructure interface.
Processes a received ICMPv6 message from the infrastructure interface. Malformed or undesired messages are dropped silently.
Adds a Multicast Listener with given address and expire time.
Adds a DNS/SRP Unicast Service entry with address in Service Data to the local Thread Network Data.
Removes a DNS/SRP Unicast Service entry with address in Service Data from the local Thread Network Data.
Adds a DNS/SRP Unicast Service entry with address in Server Data to the local Thread Network Data.
Overloads operator `<` to compare two IPv6 addresses.
Sets the IPv6 address.
Sets the Target Address field.
Indicates whether the entry matches a given IPv6 address.
Indicates whether or not @p aAddress has a matching prefix.