Symbols

loading...

Files

loading (2/5)...

Summary Syntax Arguments References Call Tree Data Use

SourceVuESP-IDF Framework and ExamplesESP-IDFot::Dns::Client::ServiceResponse::GetHostAddress() const

ot::Dns::Client::ServiceResponse::GetHostAddress() const method

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`.

Syntax

Show:

Summary

Declaration

Definition

from dns_client.hpp:558

Error GetHostAddress(const char *aHostName, uint16_t aIndex, Ip6::Address &aAddress, uint32_t &aTtl) const;

Implemented in dns_client.cpp:651

Arguments

Argument

Description

aHostName

The host name to get the address (MUST NOT be `nullptr`).

aIndex

The address record index to retrieve.

aAddress

A reference to an IPv6 address to output the address.

aTtl

A reference to a `uint32_t` to output TTL for the address.

Return value

kErrorNone The address was read successfully. kErrorNotFound No address record for @p aHostname at @p aIndex. kErrorParse Could not parse the records.

References

Code

Location

Error Client::ServiceResponse::GetHostAddress(const char *aHostName,

dns_client.cpp:651

Error GetHostAddress(const char *aHostName, uint16_t aIndex, Ip6::Address &aAddress, uint32_t &aTtl) const;

dns_client.hpp:558

Call Tree

ot::Dns::Client::ServiceResponse::GetHostAddress() const calls 3 functions:

ot::Dns::Client::ServiceResponse::GetHostAddress() const

ot::Dns::Client::QueryInfo::ReadFrom()

ot::Dns::Name::Name()

ot::Dns::Client::Response::FindHostAddress() const

Data Use

ot::Dns::Client::ServiceResponse::GetHostAddress() const reads 8 variables:

ot::Dns::Client::Response::Section::kAnswerSection

ot::Dns::Client::Response::Section::kAdditionalDataSection

ot::Dns::Client::Response::mNext

ot::Dns::Client::QueryType::kIp6AddressQuery

ot::Dns::Client::QueryType::kIp4AddressQuery

ot::Dns::Client::QueryInfo::mQueryType

ot::kErrorNotFound

ot::Dns::Client::ServiceResponse::GetHostAddress() const

Class Tree

All items filtered out

All items filtered out

Override Tree

All items filtered out

All items filtered out

Implementations

All items filtered out

All items filtered out

Instances

Lifecycle

All items filtered out

All items filtered out