Symbols ![]()
loading...
Files ![]()
loading...
otDnsServiceInfo struct
Provides info for a DNS service instance.
Syntax
typedef struct otDnsServiceInfo
{
uint32_t mTtl;
uint16_t mPort;
uint16_t mPriority;
uint16_t mWeight;
char *mHostNameBuffer;
uint16_t mHostNameBufferSize;
otIp6Address mHostAddress;
uint32_t mHostAddressTtl;
uint8_t *mTxtData;
uint16_t mTxtDataSize;
bool mTxtDataTruncated;
uint32_t mTxtDataTtl;
} otDnsServiceInfo;
Fields
Field
Declared as
uint32_t
uint16_t
uint16_t
uint16_t
uint8_t *
uint16_t
uint32_t
Related Functions
Found 8 other functions taking a otDnsServiceInfo
argument:
Function
Description
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()`.
Gets info for a service instance from a DNS service instance resolution response. MUST only be used from a `otDnsServiceCallback` triggered from `otDnsClientResolveService()` or `otDnsClientResolveServiceAndHostAddress()`. When this is is used from a `otDnsClientResolveService()` callback, the DNS response from server/resolver may include AAAA records in its Additional Data section for the host name associated with the service instance that is resolved. This is a SHOULD and not a MUST requirement so servers/resolvers are not required to provide this. This function attempts to parse AAAA record(s) if included in the response. If it is not included `mHostAddress` is set to all zeros (unspecified address). To also resolve the host address, user can use the DNS client API function `otDnsClientResolveServiceAndHostAddress()` which will perform service resolution followed up by a host name address resolution query (when AAAA records are not provided by server/resolver in the SRV query response). - If a matching SRV record is found in @p aResponse, @p aServiceInfo is updated. - If no matching SRV record is found, `OT_ERROR_NOT_FOUND` is returned unless the query config for this query used `OT_DNS_SERVICE_MODE_TXT` for `mServiceMode` (meaning the request was only for TXT record). In this case, we still try to parse the SRV record from Additional Data Section of response (in case server provided the info). - 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 `otDnsServiceResponseGetHostAddress()`.
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.
Gets info for a service instance from a DNS service instance resolution response. MUST only be used from `ServiceCallback`. - If no matching SRV record is found, `kErrorNotFound` is returned. - If a matching SRV record is found, @p aServiceInfo is updated and `kErrorNone` is returned. - 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.