Symbols

Files

Summary Syntax Methods References Class Tree Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFot::Dns::Client

ot::Dns::Client class

Implements DNS client.

Syntax

Show:

Summary

Declaration

from dns_client.hpp:104

class Client : public InstanceLocator, private NonCopyable { friend class ot::Srp::Client; typedef Message Query; public: class QueryConfig : public otDnsQueryConfig, public Clearable<QueryConfig> { friend class Client; public: enum RecursionFlag : uint8_t { kFlagUnspecified = OT_DNS_FLAG_UNSPECIFIED, kFlagRecursionDesired = OT_DNS_FLAG_RECURSION_DESIRED, kFlagNoRecursion = OT_DNS_FLAG_NO_RECURSION, }; #if OPENTHREAD_CONFIG_DNS_CLIENT_NAT64_ENABLE enum Nat64Mode : uint8_t { kNat64Unspecified = OT_DNS_NAT64_UNSPECIFIED, kNat64Allow = OT_DNS_NAT64_ALLOW, kNat64Disallow = OT_DNS_NAT64_DISALLOW, }; #endif enum ServiceMode : uint8_t { kServiceModeUnspecified = OT_DNS_SERVICE_MODE_UNSPECIFIED, kServiceModeSrv = OT_DNS_SERVICE_MODE_SRV, kServiceModeTxt = OT_DNS_SERVICE_MODE_TXT, kServiceModeSrvTxt = OT_DNS_SERVICE_MODE_SRV_TXT, kServiceModeSrvTxtSeparate = OT_DNS_SERVICE_MODE_SRV_TXT_SEPARATE, kServiceModeSrvTxtOptimize = OT_DNS_SERVICE_MODE_SRV_TXT_OPTIMIZE, }; enum TransportProto : uint8_t { kDnsTransportUnspecified = OT_DNS_TRANSPORT_UNSPECIFIED, kDnsTransportUdp = OT_DNS_TRANSPORT_UDP, kDnsTransportTcp = OT_DNS_TRANSPORT_TCP, }; QueryConfig(void) = default; const Ip6::SockAddr &GetServerSockAddr(void) const { return static_cast<const Ip6::SockAddr &>(mServerSockAddr); } uint32_t GetResponseTimeout(void) const { return mResponseTimeout; } uint8_t GetMaxTxAttempts(void) const { return mMaxTxAttempts; } RecursionFlag GetRecursionFlag(void) const { return static_cast<RecursionFlag>(mRecursionFlag); } #if OPENTHREAD_CONFIG_DNS_CLIENT_NAT64_ENABLE Nat64Mode GetNat64Mode(void) const { return static_cast<Nat64Mode>(mNat64Mode); } #endif ServiceMode GetServiceMode(void) const { return static_cast<ServiceMode>(mServiceMode); } TransportProto GetTransportProto(void) const { return static_cast<TransportProto>(mTransportProto); }; private: static constexpr uint32_t kDefaultResponseTimeout = OPENTHREAD_CONFIG_DNS_CLIENT_DEFAULT_RESPONSE_TIMEOUT; static constexpr uint16_t kDefaultServerPort = OPENTHREAD_CONFIG_DNS_CLIENT_DEFAULT_SERVER_PORT; static constexpr uint8_t kDefaultMaxTxAttempts = OPENTHREAD_CONFIG_DNS_CLIENT_DEFAULT_MAX_TX_ATTEMPTS; static constexpr bool kDefaultRecursionDesired = OPENTHREAD_CONFIG_DNS_CLIENT_DEFAULT_RECURSION_DESIRED_FLAG; static constexpr ServiceMode kDefaultServiceMode = static_cast<ServiceMode>(OPENTHREAD_CONFIG_DNS_CLIENT_DEFAULT_SERVICE_MODE); static_assert(kDefaultServiceMode != kServiceModeUnspecified, "Invalid default service mode"); #if OPENTHREAD_CONFIG_DNS_CLIENT_NAT64_ENABLE static constexpr bool kDefaultNat64Allowed = OPENTHREAD_CONFIG_DNS_CLIENT_DEFAULT_NAT64_ALLOWED; #endif enum InitMode : uint8_t { kInitFromDefaults, }; static const char kDefaultServerAddressString[]; explicit QueryConfig(InitMode aMode); Ip6::SockAddr &GetServerSockAddr(void) { return AsCoreType(&mServerSockAddr); } void SetResponseTimeout(uint32_t aResponseTimeout) { mResponseTimeout = aResponseTimeout; } void SetMaxTxAttempts(uint8_t aMaxTxAttempts) { mMaxTxAttempts = aMaxTxAttempts; } void SetRecursionFlag(RecursionFlag aFlag) { mRecursionFlag = static_cast<otDnsRecursionFlag>(aFlag); } void SetServiceMode(ServiceMode aMode) { mServiceMode = static_cast<otDnsServiceMode>(aMode); } #if OPENTHREAD_CONFIG_DNS_CLIENT_NAT64_ENABLE void SetNat64Mode(Nat64Mode aMode) { mNat64Mode = static_cast<otDnsNat64Mode>(aMode); } #endif void SetTransportProto(TransportProto aTransportProto) { mTransportProto = static_cast<otDnsTransportProto>(aTransportProto); } void SetFrom(const QueryConfig *aConfig, const QueryConfig &aDefaultConfig); }; #if OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE typedef otDnsServiceInfo ServiceInfo; #endif 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 }; typedef otDnsAddressCallback AddressCallback; class AddressResponse : public Response { friend class Client; public: Error GetHostName(char *aNameBuffer, uint16_t aNameBufferSize) const { return GetName(aNameBuffer, aNameBufferSize); } Error GetAddress(uint16_t aIndex, Ip6::Address &aAddress, uint32_t &aTtl) const; private: #if OPENTHREAD_CONFIG_DNS_CLIENT_NAT64_ENABLE Error GetNat64Prefix(Ip6::Prefix &aPrefix) const; #endif }; #if OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE typedef otDnsBrowseCallback BrowseCallback; class BrowseResponse : public Response { friend class Client; public: Error GetServiceName(char *aNameBuffer, uint16_t aNameBufferSize) const { return GetName(aNameBuffer, aNameBufferSize); } Error GetServiceInstance(uint16_t aIndex, char *aLabelBuffer, uint8_t aLabelBufferSize) const; Error GetServiceInfo(const char *aInstanceLabel, ServiceInfo &aServiceInfo) const; Error GetHostAddress(const char *aHostName, uint16_t aIndex, Ip6::Address &aAddress, uint32_t &aTtl) const; private: Error FindPtrRecord(const char *aInstanceLabel, Name &aInstanceName) const; }; typedef otDnsServiceCallback ServiceCallback; class ServiceResponse : public Response { friend class Client; public: Error GetServiceName(char *aLabelBuffer, uint8_t aLabelBufferSize, char *aNameBuffer, uint16_t aNameBufferSize) const; Error GetServiceInfo(ServiceInfo &aServiceInfo) const; Error GetHostAddress(const char *aHostName, uint16_t aIndex, Ip6::Address &aAddress, uint32_t &aTtl) const; }; #endif explicit Client(Instance &aInstance); Error Start(void); void Stop(void); const QueryConfig &GetDefaultConfig(void) const { return mDefaultConfig; } void SetDefaultConfig(const QueryConfig &aQueryConfig); void ResetDefaultConfig(void); Error ResolveAddress(const char *aHostName, AddressCallback aCallback, void *aContext, const QueryConfig *aConfig = nullptr); #if OPENTHREAD_CONFIG_DNS_CLIENT_NAT64_ENABLE Error ResolveIp4Address(const char *aHostName, AddressCallback aCallback, void *aContext, const QueryConfig *aConfig = nullptr); #endif #if OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE Error Browse(const char *aServiceName, BrowseCallback aCallback, void *aContext, const QueryConfig *aConfig = nullptr); Error ResolveService(const char *aInstanceLabel, const char *aServiceName, otDnsServiceCallback aCallback, void *aContext, const QueryConfig *aConfig = nullptr); Error ResolveServiceAndHostAddress(const char *aInstanceLabel, const char *aServiceName, ServiceCallback aCallback, void *aContext, const QueryConfig *aConfig = nullptr); #endif private: static constexpr uint16_t kMaxCnameAliasNameChanges = 40; static constexpr uint8_t kLimitedQueryServersArraySize = 3; enum QueryType : uint8_t { kIp6AddressQuery, #if OPENTHREAD_CONFIG_DNS_CLIENT_NAT64_ENABLE kIp4AddressQuery, #endif #if OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE kBrowseQuery, kServiceQuerySrvTxt, kServiceQuerySrv, kServiceQueryTxt, #endif kNoQuery, }; #if OPENTHREAD_CONFIG_DNS_CLIENT_OVER_TCP_ENABLE enum TcpState : uint8_t { kTcpUninitialized = 0, kTcpConnecting, kTcpConnectedIdle, kTcpConnectedSending, }; #endif union Callback { AddressCallback mAddressCallback; #if OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE BrowseCallback mBrowseCallback; ServiceCallback mServiceCallback; #endif }; typedef MessageQueue QueryList; struct QueryInfo : public Clearable<QueryInfo> { void ReadFrom(const Query &aQuery) { IgnoreError(aQuery.Read(0, *this)); } QueryType mQueryType; uint16_t mMessageId; Callback mCallback; void *mCallbackContext; TimeMilli mRetransmissionTime; QueryConfig mConfig; uint8_t mTransmissionCount; bool mShouldResolveHostAddr; Query *mMainQuery; Query *mNextQuery; Message *mSavedResponse; }; static constexpr uint16_t kNameOffsetInQuery = sizeof(QueryInfo); Error StartQuery(QueryInfo &aInfo, const char *aLabel, const char *aName, QueryType aSecondType = kNoQuery); Error AllocateQuery(const QueryInfo &aInfo, const char *aLabel, const char *aName, Query *&aQuery); void FreeQuery(Query &aQuery); void UpdateQuery(Query &aQuery, const QueryInfo &aInfo) { aQuery.Write(0, aInfo); } Query &FindMainQuery(Query &aQuery); Error SendQuery(Query &aQuery, QueryInfo &aInfo, bool aUpdateTimer); void FinalizeQuery(Query &aQuery, Error aError); void FinalizeQuery(Response &Response, Error aError); static void GetQueryTypeAndCallback(const Query &aQuery, QueryType &aType, Callback &aCallback, void *&aContext); Error AppendNameFromQuery(const Query &aQuery, Message &aMessage); Query *FindQueryById(uint16_t aMessageId); void HandleUdpReceive(Message &aMessage, const Ip6::MessageInfo &aMsgInfo); void ProcessResponse(const Message &aResponseMessage); Error ParseResponse(const Message &aResponseMessage, Query *&aQuery, Error &aResponseError); bool CanFinalizeQuery(Query &aQuery); void SaveQueryResponse(Query &aQuery, const Message &aResponseMessage); Query *PopulateResponse(Response &aResponse, Query &aQuery, const Message &aResponseMessage); void PrepareResponseAndFinalize(Query &aQuery, const Message &aResponseMessage, Response *aPrevResponse); void HandleTimer(void); #if OPENTHREAD_CONFIG_DNS_CLIENT_NAT64_ENABLE Error ReplaceWithIp4Query(Query &aQuery, const Message &aResponseMessage); #endif #if OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE Error Resolve(const char *aInstanceLabel, const char *aServiceName, ServiceCallback aCallback, void *aContext, const QueryConfig *aConfig, bool aShouldResolveHostAddr); void CheckAndUpdateServiceMode(QueryConfig &aConfig, const QueryConfig *aRequestConfig) const; void RecordServerAsLimitedToSingleQuestion(const Ip6::Address &aServerAddress); void RecordServerAsCapableOfMultiQuestions(const Ip6::Address &aServerAddress); Error ReplaceWithSeparateSrvTxtQueries(Query &aQuery); void ResolveHostAddressIfNeeded(Query &aQuery, const Message &aResponseMessage); #endif #if OPENTHREAD_CONFIG_DNS_CLIENT_DEFAULT_SERVER_ADDRESS_AUTO_SET_ENABLE void UpdateDefaultConfigAddress(void); #endif #if OPENTHREAD_CONFIG_DNS_CLIENT_OVER_TCP_ENABLE static void HandleTcpEstablishedCallback(otTcpEndpoint *aEndpoint); static void HandleTcpSendDoneCallback(otTcpEndpoint *aEndpoint, otLinkedBuffer *aData); static void HandleTcpDisconnectedCallback(otTcpEndpoint *aEndpoint, otTcpDisconnectedReason aReason); static void HandleTcpReceiveAvailableCallback(otTcpEndpoint *aEndpoint, size_t aBytesAvailable, bool aEndOfStream, size_t aBytesRemaining); void HandleTcpEstablished(otTcpEndpoint *aEndpoint); void HandleTcpSendDone(otTcpEndpoint *aEndpoint, otLinkedBuffer *aData); void HandleTcpDisconnected(otTcpEndpoint *aEndpoint, otTcpDisconnectedReason aReason); void HandleTcpReceiveAvailable(otTcpEndpoint *aEndpoint, size_t aBytesAvailable, bool aEndOfStream, size_t aBytesRemaining); Error InitTcpSocket(void); Error ReadFromLinkBuffer(const otLinkedBuffer *&aLinkedBuffer, size_t &aOffset, Message &aMessage, uint16_t aLength); void PrepareTcpMessage(Message &aMessage); #endif static const uint8_t kQuestionCount[]; static const uint16_t *const kQuestionRecordTypes[]; static const uint16_t kIp6AddressQueryRecordTypes[]; #if OPENTHREAD_CONFIG_DNS_CLIENT_NAT64_ENABLE static const uint16_t kIp4AddressQueryRecordTypes[]; #endif #if OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE static const uint16_t kBrowseQueryRecordTypes[]; static const uint16_t kServiceQueryRecordTypes[]; #endif static constexpr uint16_t kUdpQueryMaxSize = 512; using RetryTimer = TimerMilliIn<Client, &Client::HandleTimer>; using ClientSocket = Ip6::Udp::SocketIn<Client, &Client::HandleUdpReceive>; ClientSocket mSocket; #if OPENTHREAD_CONFIG_DNS_CLIENT_OVER_TCP_ENABLE Ip6::Tcp::Endpoint mEndpoint; otLinkedBuffer mSendLink; uint8_t mSendBufferBytes[OPENTHREAD_CONFIG_DNS_CLIENT_OVER_TCP_QUERY_MAX_SIZE]; uint8_t mReceiveBufferBytes[OPENTHREAD_CONFIG_DNS_CLIENT_OVER_TCP_QUERY_MAX_SIZE]; TcpState mTcpState; #endif QueryList mMainQueries; RetryTimer mTimer; QueryConfig mDefaultConfig; #if OPENTHREAD_CONFIG_DNS_CLIENT_DEFAULT_SERVER_ADDRESS_AUTO_SET_ENABLE bool mUserDidSetDefaultAddress; #endif Array<Ip6::Address, kLimitedQueryServersArraySize> mLimitedQueryServers; };

Fields

Field

Declared as

ot::Dns::Client::kMaxCnameAliasNameChanges

ot::Dns::Client::kLimitedQueryServersArraySize

ot::Dns::Client::kNameOffsetInQuery

ot::Dns::Client::kQuestionCount

ot::Dns::Client::kQuestionRecordTypes

ot::Dns::Client::kIp6AddressQueryRecordTypes

ot::Dns::Client::kIp4AddressQueryRecordTypes

ot::Dns::Client::kBrowseQueryRecordTypes

ot::Dns::Client::kServiceQueryRecordTypes

ot::Dns::Client::kUdpQueryMaxSize

ot::Dns::Client::mSocket

ClientSocket

ot::Dns::Client::mMainQueries

QueryList

ot::Dns::Client::mTimer

RetryTimer

ot::Dns::Client::mDefaultConfig

QueryConfig

ot::Dns::Client::mUserDidSetDefaultAddress

bool

ot::Dns::Client::mLimitedQueryServers

Array<Ip6::Address, kLimitedQueryServersArraySize>

Methods

Start()

Starts the DNS client.

Stop()

Stops the DNS client.

GetDefaultConfig() const

Gets the current default query config being used by DNS client.

SetDefaultConfig()

Sets the default query config.

ResetDefaultConfig()

Resets the default config to the config used when the OpenThread stack starts. When OpenThread stack starts, the default DNS query config is determined from a set of OT config options such as `OPENTHREAD_CONFIG_DNS_CLIENT_DEFAULT_SERVER_IP6_ADDRESS`, `_DEFAULT_SERVER_PORT`, or `_DEFAULT_RESPONSE_TIMEOUT` etc. (see `config/dns_client.h` for all related config options).

ResolveAddress()

Sends an address resolution DNS query for AAAA (IPv6) record for a given host name. The @p aConfig can be nullptr. In this case the default config (from `GetDefaultConfig()`) will be used as the config for this query. In a non-nullptr @p aConfig, some of the fields can be left unspecified (value zero). The unspecified fields are then replaced by the values from the default config.

ResolveIp4Address()

Sends an address resolution DNS query for A (IPv4) record for a given host name. When a successful response is received, the addresses are returned from @p aCallback as NAT64 IPv6 translated versions of the IPv4 addresses from the query response. The @p aConfig can be nullptr. In this case the default config (from `GetDefaultConfig()`) will be used as the config for this query. In a non-nullptr @p aConfig, some of the fields can be left unspecified (value zero). The unspecified fields are then replaced by the values from the default config.

Browse()

Sends a browse (service instance enumeration) DNS query for a given service name. The @p aConfig can be nullptr. In this case the default config (from `GetDefaultConfig()`) will be used as the config for this query. In a non-nullptr @p aConfig, some of the fields can be left unspecified (value zero). The unspecified fields are then replaced by the values from the default config.

ResolveService()

Starts a DNS service instance resolution for a given service instance. The @p aConfig can be `nullptr`. In this case the default config (from `GetDefaultConfig()`) will be used as the config for this query. In a non-`nullptr` @p aConfig, some of the fields can be left unspecified (value zero). The unspecified fields are then replaced by the values from the default config.

ResolveServiceAndHostAddress()

Starts a DNS service instance resolution for a given service instance, with a potential follow-up host name resolution (if the server/resolver does not provide AAAA/A records for the host name in the response to SRV query). The @p aConfig can be `nullptr`. In this case the default config (from `GetDefaultConfig()`) will be used as the config for this query. In a non-`nullptr` @p aConfig, some of the fields can be left unspecified (value zero). The unspecified fields are then replaced by the values from the default config.

ot::Dns::Client class

Syntax

Fields

Methods

Start()

Stop()

GetDefaultConfig() const

SetDefaultConfig()

ResetDefaultConfig()

ResolveAddress()

ResolveIp4Address()

Browse()

ResolveService()

ResolveServiceAndHostAddress()

StartQuery()

AllocateQuery()

FreeQuery()

UpdateQuery()

FindMainQuery()

SendQuery()

FinalizeQuery()

FinalizeQuery()

GetQueryTypeAndCallback()

AppendNameFromQuery()

FindQueryById()

HandleUdpReceive()

ProcessResponse()

ParseResponse()

CanFinalizeQuery()

SaveQueryResponse()

PopulateResponse()

PrepareResponseAndFinalize()

HandleTimer()

ReplaceWithIp4Query()

Resolve()

CheckAndUpdateServiceMode() const

RecordServerAsLimitedToSingleQuestion()

RecordServerAsCapableOfMultiQuestions()

ReplaceWithSeparateSrvTxtQueries()

ResolveHostAddressIfNeeded()

UpdateDefaultConfigAddress()

ResolveService()

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle