Symbols ![]()
loading...
Files ![]()
loading...
otDnsBrowseResponseGetServiceInfo() function
Gets info for a service instance from a DNS browse (service instance enumeration) response. MUST only be used from `otDnsBrowseCallback`. A browse DNS response can include SRV, TXT, and AAAA records for the service instances that are enumerated. This is a SHOULD and not a MUST requirement, and servers/resolvers are not required to provide this. This function attempts to retrieve this info for a given service instance when available. - If no matching SRV record is found in @p aResponse, `OT_ERROR_NOT_FOUND` is returned. In this case, no additional records (no TXT and/or AAAA) are read. - If a matching SRV record is found in @p aResponse, @p aServiceInfo is updated and `OT_ERROR_NONE` is returned. - If no matching TXT record is found in @p aResponse, `mTxtDataSize` in @p aServiceInfo is set to zero. - If TXT data length is greater than `mTxtDataSize`, it is read partially and `mTxtDataTruncated` is set to true. - If no matching AAAA record is found in @p aResponse, `mHostAddress is set to all zero or unspecified address. - If there are multiple AAAA records for the host name in @p aResponse, `mHostAddress` is set to the first one. The other addresses can be retrieved using `otDnsBrowseResponseGetHostAddress()`.
Syntax
otError otDnsBrowseResponseGetServiceInfo(const otDnsBrowseResponse *aResponse,
const char *aInstanceLabel,
otDnsServiceInfo *aServiceInfo);
Implemented in ![]()
dns_api.cpp:173
Return value
OT_ERROR_NONE The service instance info was read. @p aServiceInfo is updated. OT_ERROR_NOT_FOUND Could not find a matching SRV record for @p aInstanceLabel. OT_ERROR_NO_BUFS The host name and/or TXT data could not fit in the given buffers. OT_ERROR_PARSE Could not parse the records in the @p aResponse.
Related Functions
Found 4 other functions taking a ![]()
otDnsBrowseResponse
argument:
Function
Description
Gets the service name associated with a DNS browse (service instance enumeration) response. MUST only be used from `otDnsBrowseCallback`.
Gets a service instance associated with a DNS browse (service instance enumeration) response. MUST only be used from `otDnsBrowseCallback`. The response may include multiple service instance records. @p aIndex can be used to iterate through the list. Index zero gives the first record. When we reach end of the list, `OT_ERROR_NOT_FOUND` is returned. Note that this function gets the service instance label and not the full service instance name which is of the form `..`.
Gets the host IPv6 address from a DNS browse (service instance enumeration) response. MUST only be used from `otDnsBrowseCallback`. 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, `OT_ERROR_NOT_FOUND` is returned.