Multicast DNS
This module includes APIs for Multicast DNS (mDNS).
Summary
The mDNS APIs are available when the mDNS support OPENTHREAD_CONFIG_MULTICAST_DNS_ENABLE
is enabled and the OPENTHREAD_CONFIG_MULTICAST_DNS_PUBLIC_API_ENABLE
is also enabled.
Enumerations |
|
---|---|
otMdnsEntryState{
|
enum Represents a host/service/key entry state. |
Typedefs |
|
---|---|
otMdnsAddressAndTtl
|
typedefstruct otMdnsAddressAndTtl
Represents a discovered host address and its TTL. |
otMdnsAddressCallback)(otInstance *aInstance, const otMdnsAddressResult *aResult)
|
typedefvoid(*
Represents the callback function use to report a IPv6/IPv4 address resolve result. |
otMdnsAddressResolver
|
typedefstruct otMdnsAddressResolver
Represents an address resolver. |
otMdnsAddressResult
|
typedefstruct otMdnsAddressResult
|
otMdnsBrowseCallback)(otInstance *aInstance, const otMdnsBrowseResult *aResult)
|
typedefvoid(*
Represents the callback function used to report a browse result. |
otMdnsBrowseResult
|
typedefstruct otMdnsBrowseResult
|
otMdnsBrowser
|
typedefstruct otMdnsBrowser
Represents a service browser. |
otMdnsConflictCallback)(otInstance *aInstance, const char *aName, const char *aServiceType)
|
typedefvoid(*
Represents the callback function to report a detected name conflict after successful registration of an entry. |
otMdnsEntryState
|
typedefenum otMdnsEntryState
Represents a host/service/key entry state. |
otMdnsHost
|
typedef Represents an mDNS host. |
otMdnsIterator
|
typedefstruct otMdnsIterator
Represents an mDNS entry iterator. |
otMdnsKey
|
typedef Represents an mDNS key record. |
otMdnsRegisterCallback
|
typedef Represents the callback function to report the outcome of a host, service, or key registration request. |
otMdnsRequestId
|
typedef Represents a request ID ( uint32_t value) for registering a host, a service, or a key service. |
otMdnsService
|
typedef Represents an mDNS service. |
otMdnsSrvCallback)(otInstance *aInstance, const otMdnsSrvResult *aResult)
|
typedefvoid(*
Represents the callback function used to report an SRV resolve result. |
otMdnsSrvResolver
|
typedefstruct otMdnsSrvResolver
Represents an SRV service resolver. |
otMdnsSrvResult
|
typedefstruct otMdnsSrvResult
|
otMdnsTxtCallback)(otInstance *aInstance, const otMdnsTxtResult *aResult)
|
typedefvoid(*
Represents the callback function used to report a TXT resolve result. |
otMdnsTxtResolver
|
typedefstruct otMdnsTxtResolver
Represents a TXT service resolver. |
otMdnsTxtResult
|
typedefstruct otMdnsTxtResult
|
Functions |
|
---|---|
otMdnsAllocateIterator(otInstance *aInstance)
|
Allocates a new iterator.
|
otMdnsFreeIterator(otInstance *aInstance, otMdnsIterator *aIterator)
|
void
Frees a previously allocated iterator.
|
otMdnsGetNextHost(otInstance *aInstance, otMdnsIterator *aIterator, otMdnsHost *aHost, otMdnsEntryState *aState)
|
Iterates over registered host entries.
|
otMdnsGetNextKey(otInstance *aInstance, otMdnsIterator *aIterator, otMdnsKey *aKey, otMdnsEntryState *aState)
|
Iterates over registered key entries.
|
otMdnsGetNextService(otInstance *aInstance, otMdnsIterator *aIterator, otMdnsService *aService, otMdnsEntryState *aState)
|
Iterates over registered service entries.
|
otMdnsIsEnabled(otInstance *aInstance)
|
bool
Indicates whether the mDNS module is enabled.
|
otMdnsIsQuestionUnicastAllowed(otInstance *aInstance)
|
bool
Indicates whether mDNS module is allowed to send "QU" questions requesting unicast response.
|
otMdnsRegisterHost(otInstance *aInstance, const otMdnsHost *aHost, otMdnsRequestId aRequestId, otMdnsRegisterCallback aCallback)
|
Registers or updates a host on mDNS.
|
otMdnsRegisterKey(otInstance *aInstance, const otMdnsKey *aKey, otMdnsRequestId aRequestId, otMdnsRegisterCallback aCallback)
|
Registers or updates a key record on mDNS module.
|
otMdnsRegisterService(otInstance *aInstance, const otMdnsService *aService, otMdnsRequestId aRequestId, otMdnsRegisterCallback aCallback)
|
Registers or updates a service on mDNS.
|
otMdnsSetConflictCallback(otInstance *aInstance, otMdnsConflictCallback aCallback)
|
void
Sets the post-registration conflict callback.
|
otMdnsSetEnabled(otInstance *aInstance, bool aEnable, uint32_t aInfraIfIndex)
|
Enables or disables the mDNS module.
|
otMdnsSetQuestionUnicastAllowed(otInstance *aInstance, bool aAllow)
|
void
Sets whether the mDNS module is allowed to send questions requesting unicast responses referred to as "QU" questions.
|
otMdnsStartBrowser(otInstance *aInstance, const otMdnsBrowser *aBrowser)
|
Starts a service browser.
|
otMdnsStartIp4AddressResolver(otInstance *aInstance, const otMdnsAddressResolver *aResolver)
|
Starts an IPv4 address resolver.
|
otMdnsStartIp6AddressResolver(otInstance *aInstance, const otMdnsAddressResolver *aResolver)
|
Starts an IPv6 address resolver.
|
otMdnsStartSrvResolver(otInstance *aInstance, const otMdnsSrvResolver *aResolver)
|
Starts an SRV record resolver.
|
otMdnsStartTxtResolver(otInstance *aInstance, const otMdnsTxtResolver *aResolver)
|
Starts a TXT record resolver.
|
otMdnsStopBrowser(otInstance *aInstance, const otMdnsBrowser *aBroswer)
|
Stops a service browser.
|
otMdnsStopIp4AddressResolver(otInstance *aInstance, const otMdnsAddressResolver *aResolver)
|
Stops an IPv4 address resolver.
|
otMdnsStopIp6AddressResolver(otInstance *aInstance, const otMdnsAddressResolver *aResolver)
|
Stops an IPv6 address resolver.
|
otMdnsStopSrvResolver(otInstance *aInstance, const otMdnsSrvResolver *aResolver)
|
Stops an SRV record resolver.
|
otMdnsStopTxtResolver(otInstance *aInstance, const otMdnsTxtResolver *aResolver)
|
Stops a TXT record resolver.
|
otMdnsUnregisterHost(otInstance *aInstance, const otMdnsHost *aHost)
|
Unregisters a host on mDNS.
|
otMdnsUnregisterKey(otInstance *aInstance, const otMdnsKey *aKey)
|
Unregisters a key record on mDNS.
|
otMdnsUnregisterService(otInstance *aInstance, const otMdnsService *aService)
|
Unregisters a service on mDNS module.
|
Structs |
|
---|---|
otMdnsAddressAndTtl |
Represents a discovered host address and its TTL. |
otMdnsAddressResolver |
Represents an address resolver. |
otMdnsAddressResult |
Represents address resolver result. |
otMdnsBrowseResult |
Represents a browse result. |
otMdnsBrowser |
Represents a service browser. |
otMdnsSrvResolver |
Represents an SRV service resolver. |
otMdnsSrvResult |
Represents an SRV resolver result. |
otMdnsTxtResolver |
Represents a TXT service resolver. |
otMdnsTxtResult |
Represents a TXT resolver result. |
Enumerations
otMdnsEntryState
otMdnsEntryState
Represents a host/service/key entry state.
Typedefs
otMdnsAddressAndTtl
struct otMdnsAddressAndTtl otMdnsAddressAndTtl
Represents a discovered host address and its TTL.
otMdnsAddressCallback
void(* otMdnsAddressCallback)(otInstance *aInstance, const otMdnsAddressResult *aResult)
Represents the callback function use to report a IPv6/IPv4 address resolve result.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otMdnsAddressResolver
struct otMdnsAddressResolver otMdnsAddressResolver
Represents an address resolver.
otMdnsAddressResult
struct otMdnsAddressResult otMdnsAddressResult
otMdnsBrowseCallback
void(* otMdnsBrowseCallback)(otInstance *aInstance, const otMdnsBrowseResult *aResult)
Represents the callback function used to report a browse result.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otMdnsBrowseResult
struct otMdnsBrowseResult otMdnsBrowseResult
otMdnsConflictCallback
void(* otMdnsConflictCallback)(otInstance *aInstance, const char *aName, const char *aServiceType)
Represents the callback function to report a detected name conflict after successful registration of an entry.
If a conflict is detected while registering an entry, it is reported through the provided otMdnsRegisterCallback
. The otMdnsConflictCallback
is used only when a name conflict is detected after an entry has been successfully registered.
A non-NULL aServiceType
indicates that conflict is for a service entry. In this case aName
specifies the service instance label (treated as as a single DNS label and can potentially include dot .
character).
A NULL aServiceType
indicates that conflict is for a host entry. In this case Name
specifies the host name. It does not include the domain name.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
otMdnsHost
otPlatDnssdHost otMdnsHost
Represents an mDNS host.
This type is used to register or unregister a host (otMdnsRegisterHost()
and otMdnsUnregisterHost()
).
See the description of each function for more details on how different fields are used in each case.
otMdnsKey
otPlatDnssdKey otMdnsKey
Represents an mDNS key record.
See otMdnsRegisterKey()
, otMdnsUnregisterKey()
for more details about fields in each case.
otMdnsRegisterCallback
otPlatDnssdRegisterCallback otMdnsRegisterCallback
Represents the callback function to report the outcome of a host, service, or key registration request.
The outcome of a registration request is reported back by invoking this callback with one of the following aError
inputs:
OT_ERROR_NONE
indicates registration was successful.OT_ERROR_DUPLICATED
indicates a name conflict while probing, i.e., name is claimed by another mDNS responder.
See otMdnsRegisterHost()
, otMdnsRegisterService()
, and otMdnsRegisterKey()
for more details about when the callback will be invoked.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
otMdnsRequestId
otPlatDnssdRequestId otMdnsRequestId
Represents a request ID (uint32_t
value) for registering a host, a service, or a key service.
otMdnsService
otPlatDnssdService otMdnsService
Represents an mDNS service.
This type is used to register or unregister a service (otMdnsRegisterService()
and otMdnsUnregisterService()
).
See the description of each function for more details on how different fields are used in each case.
otMdnsSrvCallback
void(* otMdnsSrvCallback)(otInstance *aInstance, const otMdnsSrvResult *aResult)
Represents the callback function used to report an SRV resolve result.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otMdnsSrvResult
struct otMdnsSrvResult otMdnsSrvResult
otMdnsTxtCallback
void(* otMdnsTxtCallback)(otInstance *aInstance, const otMdnsTxtResult *aResult)
Represents the callback function used to report a TXT resolve result.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otMdnsTxtResult
struct otMdnsTxtResult otMdnsTxtResult
Functions
otMdnsAllocateIterator
otMdnsIterator * otMdnsAllocateIterator( otInstance *aInstance )
Allocates a new iterator.
An allocated iterator must be freed by the caller using otMdnsFreeIterator()
.
Details | |||
---|---|---|---|
Parameters |
|
||
Returns |
A pointer to the allocated iterator, or
NULL if it fails to allocate. |
otMdnsFreeIterator
void otMdnsFreeIterator( otInstance *aInstance, otMdnsIterator *aIterator )
Frees a previously allocated iterator.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otMdnsGetNextHost
otError otMdnsGetNextHost( otInstance *aInstance, otMdnsIterator *aIterator, otMdnsHost *aHost, otMdnsEntryState *aState )
Iterates over registered host entries.
On success, aHost
is populated with information about the next host. Pointers within the otMdnsHost
structure (like mName
) remain valid until the next call to any OpenThread stack's public or platform API/callback.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
|
||||||||
Return Values |
|
otMdnsGetNextKey
otError otMdnsGetNextKey( otInstance *aInstance, otMdnsIterator *aIterator, otMdnsKey *aKey, otMdnsEntryState *aState )
Iterates over registered key entries.
On success, aKey
is populated with information about the next key. Pointers within the otMdnsKey
structure (like mName
) remain valid until the next call to any OpenThread stack's public or platform API/callback.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
|
||||||||
Return Values |
|
otMdnsGetNextService
otError otMdnsGetNextService( otInstance *aInstance, otMdnsIterator *aIterator, otMdnsService *aService, otMdnsEntryState *aState )
Iterates over registered service entries.
On success, aService
is populated with information about the next service . Pointers within the otMdnsService
structure (like mServiceType
, mSubTypeLabels
) remain valid until the next call to any OpenThread stack's public or platform API/callback.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
|
||||||||
Return Values |
|
otMdnsIsEnabled
bool otMdnsIsEnabled( otInstance *aInstance )
Indicates whether the mDNS module is enabled.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
||||
Return Values |
|
otMdnsIsQuestionUnicastAllowed
bool otMdnsIsQuestionUnicastAllowed( otInstance *aInstance )
Indicates whether mDNS module is allowed to send "QU" questions requesting unicast response.
Details | |||||
---|---|---|---|---|---|
Return Values |
|
otMdnsRegisterHost
otError otMdnsRegisterHost( otInstance *aInstance, const otMdnsHost *aHost, otMdnsRequestId aRequestId, otMdnsRegisterCallback aCallback )
Registers or updates a host on mDNS.
The fields in aHost
follow these rules:
- The
mHostName
field specifies the host name to register (e.g., "myhost"). MUST NOT contain the domain name. - The
mAddresses
is array of IPv6 addresses to register with the host.mAddressesLength
provides the number of entries inmAddresses
array. - The
mAddresses
array can be empty with zeromAddressesLength
. In this case, mDNS will treat it as if host is unregistered and stops advertising any addresses for this the host name. - The
mTtl
specifies the TTL if non-zero. If zero, the mDNS core will choose the default TTL of 120 seconds. - Other fields in
aHost
structure are ignored in anotMdnsRegisterHost()
call.
This function can be called again for the same mHostName
to update a previously registered host entry, for example, to change the list of addresses of the host. In this case, the mDNS module will send "goodbye" announcements for any previously registered and now removed addresses and announce any newly added addresses.
The outcome of the registration request is reported back by invoking the provided aCallback
with aRequestId
as its input and one of the following aError
inputs:
OT_ERROR_NONE
indicates registration was successful.OT_ERROR_DULICATED
indicates a name conflict while probing, i.e., name is claimed by another mDNS responder.
For caller convenience, the OpenThread mDNS module guarantees that the callback will be invoked after this function returns, even in cases of immediate registration success. The aCallback
can be NULL
if caller does not want to be notified of the outcome.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
|
||||||||
Return Values |
|
otMdnsRegisterKey
otError otMdnsRegisterKey( otInstance *aInstance, const otMdnsKey *aKey, otMdnsRequestId aRequestId, otMdnsRegisterCallback aCallback )
Registers or updates a key record on mDNS module.
The fields in aKey
follow these rules:
- If the key is associated with a host entry, the
mName
field specifies the host name and themServiceType
MUST be NULL. - If the key is associated with a service entry, the
mName
filed specifies the service instance label (always treated as a single label) and themServiceType
filed specifies the service type (e.g., "_tst._udp"). In this case the DNS name for key record is
.. - The
mKeyData
field contains the key record's data withmKeyDataLength
as its length in byes. - The
mTtl
specifies the TTL if non-zero. If zero, the mDNS module will use the default TTL of 120 seconds. - Other fields in
aKey
structure are ignored in anotMdnsRegisterKey()
call.
This function can be called again for the same name to updated a previously registered key entry, for example, to change the key data or TTL.
Regarding the invocation of the aCallback
, this function behaves in the same way as described in otMdnsRegisterHost()
.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
|
||||||||
Return Values |
|
otMdnsRegisterService
otError otMdnsRegisterService( otInstance *aInstance, const otMdnsService *aService, otMdnsRequestId aRequestId, otMdnsRegisterCallback aCallback )
Registers or updates a service on mDNS.
The fields in aService
follow these rules:
- The
mServiceInstance
specifies the service instance label. It is treated as a single DNS name label. It may contain dot.
character which is allowed in a service instance label. - The
mServiceType
specifies the service type (e.g., "_tst._udp"). It is treated as multiple dot.
separated labels. It MUST NOT contain the domain name. - The
mHostName
field specifies the host name of the service. MUST NOT contain the domain name. - The
mSubTypeLabels
is an array of strings representing sub-types associated with the service. Each array entry is a sub-type label. ThemSubTypeLabels can be NULL if there is no sub-type. Otherwise, the array length is specified by
mSubTypeLabelsLength.
The
mTxtDataand
mTxtDataLengthspecify the encoded TXT data. The
mTxtDatacan be NULL or
mTxtDataLengthcan be zero to specify an empty TXT data. In this case mDNS module will use a single zero byte
[ 0 ]` as the TXT data.- The
mPort
,mWeight
, andmPriority
specify the service's parameters as specified in DNS SRV record. - The
mTtl
specifies the TTL if non-zero. If zero, the mDNS module will use the default TTL of 120 seconds. - Other fields in
aService
structure are ignored in anotMdnsRegisterService()
call.
This function can be called again for the same mServiceInstance
and mServiceType
to update a previously registered service entry, for example, to change the sub-types list, or update any parameter such as port, weight, priority, TTL, or host name. The mDNS module will send announcements for any changed info, e.g., will send "goodbye" announcements for any removed sub-types and announce any newly added sub-types.
Regarding the invocation of the aCallback
, this function behaves in the same way as described in otMdnsRegisterHost()
.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
|
||||||||
Return Values |
|
otMdnsSetConflictCallback
void otMdnsSetConflictCallback( otInstance *aInstance, otMdnsConflictCallback aCallback )
Sets the post-registration conflict callback.
If a conflict is detected while registering an entry, it is reported through the provided otMdnsRegisterCallback
. The otMdnsConflictCallback
is used only when a name conflict is detected after an entry has been successfully registered.
aCallback
can be set to NULL
if not needed. Subsequent calls will replace any previously set callback.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otMdnsSetEnabled
otError otMdnsSetEnabled( otInstance *aInstance, bool aEnable, uint32_t aInfraIfIndex )
Enables or disables the mDNS module.
The mDNS module should be enabled before registration any host, service, or key entries. Disabling mDNS will immediately stop all operations and any communication (multicast or unicast tx) and remove any previously registered entries without sending any "goodbye" announcements or invoking their callback. Once disabled, all currently active browsers and resolvers are stopped.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
||||||
Return Values |
|
otMdnsSetQuestionUnicastAllowed
void otMdnsSetQuestionUnicastAllowed( otInstance *aInstance, bool aAllow )
Sets whether the mDNS module is allowed to send questions requesting unicast responses referred to as "QU" questions.
The "QU" questions request unicast responses, in contrast to "QM" questions which request multicast responses.
When allowed, the first probe will be sent as a "QU" question. This API can be used to address platform limitation where platform socket cannot accept unicast response received on mDNS port (due to it being already bound).
Details | |||||
---|---|---|---|---|---|
Parameters |
|
otMdnsStartBrowser
otError otMdnsStartBrowser( otInstance *aInstance, const otMdnsBrowser *aBrowser )
Starts a service browser.
Initiates a continuous search for the specified mServiceType
in aBrowser
. For sub-type services, use mSubTypeLabel
to define the sub-type, for base services, set mSubTypeLabel
to NULL.
Discovered services are reported through the mCallback
function in aBrowser
. Services that have been removed are reported with a TTL value of zero. The callback may be invoked immediately with cached information (if available) and potentially before this function returns. When cached results are used, the reported TTL value will reflect the original TTL from the last received response.
Multiple browsers can be started for the same service, provided they use different callback functions.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
||||||
Return Values |
|
otMdnsStartIp4AddressResolver
otError otMdnsStartIp4AddressResolver( otInstance *aInstance, const otMdnsAddressResolver *aResolver )
Starts an IPv4 address resolver.
Initiates a continuous IPv4 address resolver for the specified host name in aResolver
.
Discovered addresses are reported through the mCallback
function in aResolver
. The IPv4 addresses are represented using the IPv4-mapped IPv6 address format in mAddresses
array. The callback is invoked whenever addresses are added or removed, providing an updated list. If all addresses are removed, the callback is invoked with an empty list (mAddresses
will be NULL, and mAddressesLength
will be zero).
The callback may be invoked immediately with cached information (if available) and potentially before this function returns. When cached result is used, the reported TTL values will reflect the original TTL from the last received response.
Multiple resolvers can be started for the same host name, provided they use different callback functions.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
||||||
Return Values |
|
otMdnsStartIp6AddressResolver
otError otMdnsStartIp6AddressResolver( otInstance *aInstance, const otMdnsAddressResolver *aResolver )
Starts an IPv6 address resolver.
Initiates a continuous IPv6 address resolver for the specified host name in aResolver
.
Discovered addresses are reported through the mCallback
function in aResolver
. The callback is invoked whenever addresses are added or removed, providing an updated list. If all addresses are removed, the callback is invoked with an empty list (mAddresses
will be NULL, and mAddressesLength
will be zero).
The callback may be invoked immediately with cached information (if available) and potentially before this function returns. When cached result is used, the reported TTL values will reflect the original TTL from the last received response.
Multiple resolvers can be started for the same host name, provided they use different callback functions.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
||||||
Return Values |
|
otMdnsStartSrvResolver
otError otMdnsStartSrvResolver( otInstance *aInstance, const otMdnsSrvResolver *aResolver )
Starts an SRV record resolver.
Initiates a continuous SRV record resolver for the specified service in aResolver
.
Discovered information is reported through the mCallback
function in aResolver
. When the service is removed it is reported with a TTL value of zero. In this case, mHostName
may be NULL and other result fields (such as mPort
) should be ignored.
The callback may be invoked immediately with cached information (if available) and potentially before this function returns. When cached result is used, the reported TTL value will reflect the original TTL from the last received response.
Multiple resolvers can be started for the same service, provided they use different callback functions.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
||||||
Return Values |
|
otMdnsStartTxtResolver
otError otMdnsStartTxtResolver( otInstance *aInstance, const otMdnsTxtResolver *aResolver )
Starts a TXT record resolver.
Initiates a continuous TXT record resolver for the specified service in aResolver
.
Discovered information is reported through the mCallback
function in aResolver
. When the TXT record is removed it is reported with a TTL value of zero. In this case, mTxtData
may be NULL, and other result fields (such as mTxtDataLength
) should be ignored.
The callback may be invoked immediately with cached information (if available) and potentially before this function returns. When cached result is used, the reported TTL value will reflect the original TTL from the last received response.
Multiple resolvers can be started for the same service, provided they use different callback functions.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
||||||
Return Values |
|
otMdnsStopBrowser
otError otMdnsStopBrowser( otInstance *aInstance, const otMdnsBrowser *aBroswer )
Stops a service browser.
No action is performed if no matching browser with the same service and callback is currently active.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
||||
Return Values |
|
otMdnsStopIp4AddressResolver
otError otMdnsStopIp4AddressResolver( otInstance *aInstance, const otMdnsAddressResolver *aResolver )
Stops an IPv4 address resolver.
No action is performed if no matching resolver with the same host name and callback is currently active.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
||||
Return Values |
|
otMdnsStopIp6AddressResolver
otError otMdnsStopIp6AddressResolver( otInstance *aInstance, const otMdnsAddressResolver *aResolver )
Stops an IPv6 address resolver.
No action is performed if no matching resolver with the same host name and callback is currently active.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
||||
Return Values |
|
otMdnsStopSrvResolver
otError otMdnsStopSrvResolver( otInstance *aInstance, const otMdnsSrvResolver *aResolver )
Stops an SRV record resolver.
No action is performed if no matching resolver with the same service and callback is currently active.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
||||
Return Values |
|
otMdnsStopTxtResolver
otError otMdnsStopTxtResolver( otInstance *aInstance, const otMdnsTxtResolver *aResolver )
Stops a TXT record resolver.
No action is performed if no matching resolver with the same service and callback is currently active.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
||||
Return Values |
|
otMdnsUnregisterHost
otError otMdnsUnregisterHost( otInstance *aInstance, const otMdnsHost *aHost )
Unregisters a host on mDNS.
The fields in aHost
follow these rules:
- The
mHostName
field specifies the host name to unregister (e.g., "myhost"). MUST NOT contain the domain name. - Other fields in
aHost
structure are ignored in anotMdnsUnregisterHost()
call.
If there is no previously registered host with the same name, no action is performed.
If there is a previously registered host with the same name, the mDNS module will send "goodbye" announcement for all previously advertised address records.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
||||
Return Values |
|
otMdnsUnregisterKey
otError otMdnsUnregisterKey( otInstance *aInstance, const otMdnsKey *aKey )
Unregisters a key record on mDNS.
The fields in aKey
follow these rules:
- If the key is associated with a host entry, the
mName
field specifies the host name and themServiceType
MUST be NULL. - If the key is associated with a service entry, the
mName
filed specifies the service instance label (always treated as a single label) and themServiceType
filed specifies the service type (e.g., "_tst._udp"). In this case the DNS name for key record is
.. - Other fields in
aKey
structure are ignored in anotMdnsUnregisterKey()
call.
If there is no previously registered key with the same name, no action is performed.
If there is a previously registered key with the same name, the mDNS module will send "goodbye" announcements for the key record.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
||||
Return Values |
|
otMdnsUnregisterService
otError otMdnsUnregisterService( otInstance *aInstance, const otMdnsService *aService )
Unregisters a service on mDNS module.
The fields in aService
follow these rules:
- The
mServiceInstance
specifies the service instance label. It is treated as a single DNS name label. It may contain dot.
character which is allowed in a service instance label. - The
mServiceType
specifies the service type (e.g., "_tst._udp"). It is treated as multiple dot.
separated labels. It MUST NOT contain the domain name. - Other fields in
aService
structure are ignored in anotMdnsUnregisterService()
call.
If there is no previously registered service with the same name, no action is performed.
If there is a previously registered service with the same name, the mDNS module will send "goodbye" announcements for all related records.
Details | |||||
---|---|---|---|---|---|
Parameters |
|
||||
Return Values |
|
Resources
OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.