ot::Dns::Client::BrowseResponse class

Represents a browse (service instance enumeration) DNS response.

Syntax

Show:

Summary

Declaration

from dns_client.hpp:393

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; };

Methods

GetServiceName() const

Gets the service name associated with a DNS browse response. MUST only be used from `BrowseCallback`.

GetServiceInstance() const

Gets a service instance associated with a DNS browse (service instance enumeration) response. MUST only be used from `BrowseCallback`. A response may include multiple service instance records. @p aIndex can be used to iterate through the list. Index zero gives the the first record. When we reach end of the list, `kErrorNotFound` is returned. Note that this method gets the service instance label and not the full service instance name which is of the form `..`.

GetServiceInfo() const

Gets info for a service instance from a DNS browse (service instance enumeration) response. MUST only be used from `BrowseCallback`. A browse DNS response should include the SRV, TXT, and AAAA records for the service instances that are enumerated (note that it is a SHOULD and not a MUST requirement). This method tries to retrieve this info for a given service instance. - If no matching SRV record is found, `kErrorNotFound` is returned. - If a matching SRV record is found, @p aServiceInfo is updated returning `kErrorNone`. - If no matching TXT record is found, `mTxtDataSize` in @p aServiceInfo is set to zero. - If no matching AAAA record is found, `mHostAddress is set to all zero or unspecified address. - If there are multiple AAAA records for the host name `mHostAddress` is set to the first one. The other addresses can be retrieved using `GetHostAddress()` method.

GetHostAddress() const

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