ESP-IDF
ot::Dns::Client::Response
is only used within ESP-IDF.
Symbol previews are coming soon...
Symbols
loading...
Files
loading...
Summary
Syntax
Methods
Related
Examples
References
Call Tree
Data Use
Class Tree
Override Tree
Implementations
Instances
Lifecycle
SourceVu
ESP-IDF Framework and Examples
ESP-IDF
ot::Dns::Client::Response
ot::Dns::Client::Response class
Represents a DNS query response.
Syntax
Show:
Summary
Declaration
from
dns_client.hpp:272
class
Response
:
public
otDnsAddressResponse
,
#if
OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE
public
otDnsBrowseResponse
,
public
otDnsServiceResponse
,
#endif
public
Clearable
<
Response
>
{
friend
class
Client
;
protected
:
enum
Section
:
uint8_t
{
kAnswerSection
,
kAdditionalDataSection
,
}
;
Response
(
void
)
{
Clear
(
)
;
}
Error
GetName
(
char
*
aNameBuffer
,
uint16_t
aNameBufferSize
)
const
;
void
SelectSection
(
Section
aSection
,
uint16_t
&
aOffset
,
uint16_t
&
aNumRecord
)
const
;
Error
CheckForHostNameAlias
(
Section
aSection
,
Name
&
aHostName
)
const
;
Error
FindHostAddress
(
Section
aSection
,
const
Name
&
aHostName
,
uint16_t
aIndex
,
Ip6
::
Address
&
aAddress
,
uint32_t
&
aTtl
)
const
;
#if
OPENTHREAD_CONFIG_DNS_CLIENT_NAT64_ENABLE
Error
FindARecord
(
Section
aSection
,
const
Name
&
aHostName
,
uint16_t
aIndex
,
ARecord
&
aARecord
)
const
;
#endif
#if
OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE
void
InitServiceInfo
(
ServiceInfo
&
aServiceInfo
)
const
;
Error
ReadServiceInfo
(
Section
aSection
,
const
Name
&
aName
,
ServiceInfo
&
aServiceInfo
)
const
;
Error
ReadTxtRecord
(
Section
aSection
,
const
Name
&
aName
,
ServiceInfo
&
aServiceInfo
)
const
;
#endif
void
PopulateFrom
(
const
Message
&
aMessage
)
;
Instance
*
mInstance
;
Query
*
mQuery
;
const
Message
*
mMessage
;
Response
*
mNext
;
uint16_t
mAnswerOffset
;
uint16_t
mAnswerRecordCount
;
uint16_t
mAdditionalOffset
;
uint16_t
mAdditionalRecordCount
;
#if
OPENTHREAD_CONFIG_DNS_CLIENT_NAT64_ENABLE
bool
mIp6QueryResponseRequiresNat64
;
#endif
}
;
Fields
Field
Declared as
ot::Dns::Client::Response::mInstance
Instance
*
ot::Dns::Client::Response::mQuery
Query
*
ot::Dns::Client::Response::mMessage
const
Message
*
ot::Dns::Client::Response::mNext
Response
*
ot::Dns::Client::Response::mAnswerOffset
uint16_t
ot::Dns::Client::Response::mAnswerRecordCount
uint16_t
ot::Dns::Client::Response::mAdditionalOffset
uint16_t
ot::Dns::Client::Response::mAdditionalRecordCount
uint16_t
ot::Dns::Client::Response::mIp6QueryResponseRequiresNat64
bool
Methods
GetName() const
SelectSection() const
CheckForHostNameAlias() const
FindHostAddress() const
FindARecord() const
InitServiceInfo() const
ReadServiceInfo() const
ReadTxtRecord() const
PopulateFrom()
Related Functions
Found 2 other functions taking a
Response
argument:
Function
ot::Dns::Client::PopulateResponse()
ot::Dns::Client::PrepareResponseAndFinalize()
Examples
References
from
examples
Code
Location
Scope
Referrer
class
Response
:
public
otDnsAddressResponse
,
dns_client.hpp:272
void
Client
::
Response
::
SelectSection
(
Section
aSection
,
uint16_t
&
aOffset
,
uint16_t
&
aNumRecord
)
const
dns_client.cpp:131
ot::Dns::Client::Response::SelectSection() const
Error
Client
::
Response
::
GetName
(
char
*
aNameBuffer
,
uint16_t
aNameBufferSize
)
const
dns_client.cpp:147
ot::Dns::Client::Response::GetName() const
Error
Client
::
Response
::
CheckForHostNameAlias
(
Section
aSection
,
Name
&
aHostName
)
const
dns_client.cpp:154
ot::Dns::Client::Response::CheckForHostNameAlias() const
Error
Client
::
Response
::
FindHostAddress
(
Section
aSection
,
dns_client.cpp:200
ot::Dns::Client::Response::FindHostAddress() const
Error
Client
::
Response
::
FindARecord
(
Section
aSection
,
const
Name
&
aHostName
,
uint16_t
aIndex
,
ARecord
&
aARecord
)
const
dns_client.cpp:225
ot::Dns::Client::Response::FindARecord() const
void
Client
::
Response
::
InitServiceInfo
(
ServiceInfo
&
aServiceInfo
)
const
dns_client.cpp:245
ot::Dns::Client::Response::InitServiceInfo() const
Error
Client
::
Response
::
ReadServiceInfo
(
Section
aSection
,
const
Name
&
aName
,
ServiceInfo
&
aServiceInfo
)
const
dns_client.cpp:263
ot::Dns::Client::Response::ReadServiceInfo() const
Error
Client
::
Response
::
ReadTxtRecord
(
Section
aSection
,
const
Name
&
aName
,
ServiceInfo
&
aServiceInfo
)
const
dns_client.cpp:321
ot::Dns::Client::Response::ReadTxtRecord() const
void
Client
::
Response
::
PopulateFrom
(
const
Message
&
aMessage
)
dns_client.cpp:377
ot::Dns::Client::Response::PopulateFrom()
for
(
const
Response
*
response
=
this
;
response
!=
nullptr
;
response
=
response
->
mNext
)
dns_client.cpp:589
ot::Dns::Client::ServiceResponse::GetServiceInfo() const
for
(
const
Response
*
response
=
this
;
response
!=
nullptr
;
response
=
response
->
mNext
)
dns_client.cpp:658
ot::Dns::Client::ServiceResponse::GetHostAddress() const
Response
response
;
dns_client.cpp:1217
ot::Dns::Client::FinalizeQuery()
void
Client
::
FinalizeQuery
(
Response
&
aResponse
,
Error
aError
)
dns_client.cpp:1226
ot::Dns::Client::FinalizeQuery()
Client
::
Query
*
Client
::
PopulateResponse
(
Response
&
aResponse
,
Query
&
aQuery
,
const
Message
&
aResponseMessage
)
dns_client.cpp:1462
ot::Dns::Client::PopulateResponse()
ot::Dns::Client::PopulateResponse()::aResponse
void
Client
::
PrepareResponseAndFinalize
(
Query
&
aQuery
,
const
Message
&
aResponseMessage
,
Response
*
aPrevResponse
)
dns_client.cpp:1479
ot::Dns::Client::PrepareResponseAndFinalize()
ot::Dns::Client::PrepareResponseAndFinalize()::aPrevResponse
Response
response
;
dns_client.cpp:1486
ot::Dns::Client::PrepareResponseAndFinalize()
Response
response
;
dns_client.cpp:1715
ot::Dns::Client::ResolveHostAddressIfNeeded()
SuccessOrExit
(
response
.
ReadServiceInfo
(
Response
::
kAnswerSection
,
Name
(
aQuery
,
kNameOffsetInQuery
)
,
serviceInfo
)
)
;
dns_client.cpp:1729
ot::Dns::Client::ResolveHostAddressIfNeeded()
Response
*
mNext
;
// The next response when we have related queries.
dns_client.hpp:312
ot::Dns::Client::Response
ot::Dns::Client::Response::mNext
class
AddressResponse
:
public
Response
dns_client.hpp:335
ot::Dns::Client
ot::Dns::Client::AddressResponse
class
BrowseResponse
:
public
Response
dns_client.hpp:393
ot::Dns::Client
ot::Dns::Client::BrowseResponse
class
ServiceResponse
:
public
Response
dns_client.hpp:495
ot::Dns::Client
ot::Dns::Client::ServiceResponse
void
FinalizeQuery
(
Response
&
Response
,
Error
aError
)
;
dns_client.hpp:794
ot::Dns::Client::FinalizeQuery()
Query
*
PopulateResponse
(
Response
&
aResponse
,
Query
&
aQuery
,
const
Message
&
aResponseMessage
)
;
dns_client.hpp:803
ot::Dns::Client::PopulateResponse()
ot::Dns::Client::PopulateResponse()::aResponse
void
PrepareResponseAndFinalize
(
Query
&
aQuery
,
const
Message
&
aResponseMessage
,
Response
*
aPrevResponse
)
;
dns_client.hpp:804
ot::Dns::Client::PrepareResponseAndFinalize()
ot::Dns::Client::PrepareResponseAndFinalize()::aPrevResponse
Call Tree
from
examples
All items filtered out
All items filtered out
Data Use
from
examples
All items filtered out
All items filtered out
Class Tree
from
examples
ot::Dns::Client::Response
inherits 3 classess and is inherited by 3 classess:
ot::Dns::Client::AddressResponse
ot::Dns::Client::BrowseResponse
ot::Dns::Client::ServiceResponse
All items filtered out
ot::Dns::Client::Response
otDnsAddressResponse
otDnsBrowseResponse
otDnsServiceResponse
All items filtered out
Override Tree
from
examples
All items filtered out
All items filtered out
Implementations
from
examples
All items filtered out
All items filtered out
Instances
from
examples
Instance
Scope
Location
Project
ot::Dns::Client::Response::mNext
ot::Dns::Client::Response
dns_client.hpp:312
ot::Dns::Client::PopulateResponse()::aResponse
ot::Dns::Client::PopulateResponse()
dns_client.hpp:803
ot::Dns::Client::PrepareResponseAndFinalize()::aPrevResponse
ot::Dns::Client::PrepareResponseAndFinalize()
dns_client.hpp:804
ot::Dns::Client::PopulateResponse()::aResponse
ot::Dns::Client::PopulateResponse()
dns_client.cpp:1462
ot::Dns::Client::PrepareResponseAndFinalize()::aPrevResponse
ot::Dns::Client::PrepareResponseAndFinalize()
dns_client.cpp:1479
Lifecycle
from
examples
All items filtered out
All items filtered out