Symbols ![]()
loading...
Files ![]()
loading (1/5)...
ot::Dns::Client::QueryConfig class
Represents a DNS query configuration (e.g., server address, response wait timeout, etc).
Syntax
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);
};
Fields
Field
Related Functions
Found 9 other functions taking a QueryConfig
argument:
Function
Description
Sets the default query config.
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.
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.
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.
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.
References
Code
Location
Scope
Referrer
Class Tree
ot::Dns::Client::QueryConfig is inherited by 1 classes:
Instances
Instance
Scope
Location
Project