Multicast DNS
Stay organized with collections
Save and categorize content based on your preferences.
This module defines platform APIs for Multicast DNS (mDNS) socket.
Summary
Typedefs |
|
---|---|
otPlatMdnsAddressInfo
|
typedefstruct otPlatMdnsAddressInfo
Represents a socket address info. |
Functions |
|
---|---|
otPlatMdnsHandleHostAddressEvent(otInstance *aInstance, const otIp6Address *aAddress, bool aAdded, uint32_t aInfraIfIndex)
|
void
Callback to notify OpenThread mDNS module of host address changes.
|
otPlatMdnsHandleReceive(otInstance *aInstance, otMessage *aMessage, bool aIsUnicast, const otPlatMdnsAddressInfo *aAddress)
|
void
Callback to notify OpenThread mDNS module of a received message on UDP port 5353.
|
otPlatMdnsSendMulticast(otInstance *aInstance, otMessage *aMessage, uint32_t aInfraIfIndex)
|
void
Sends an mDNS message as multicast.
|
otPlatMdnsSendUnicast(otInstance *aInstance, otMessage *aMessage, const otPlatMdnsAddressInfo *aAddress)
|
void
Sends an mDNS message as unicast.
|
otPlatMdnsSetListeningEnabled(otInstance *aInstance, bool aEnable, uint32_t aInfraIfIndex)
|
Enables or disables listening for mDNS messages sent to mDNS port 5353.
|
Structs |
|
---|---|
otPlatMdnsAddressInfo |
Represents a socket address info. |
Typedefs
otPlatMdnsAddressInfo
struct otPlatMdnsAddressInfo otPlatMdnsAddressInfo
Represents a socket address info.
Functions
otPlatMdnsHandleHostAddressEvent
void otPlatMdnsHandleHostAddressEvent( otInstance *aInstance, const otIp6Address *aAddress, bool aAdded, uint32_t aInfraIfIndex )
Callback to notify OpenThread mDNS module of host address changes.
When otPlatMdnsSetListeningEnabled()
enables mDNS listening on an aInfraIfIndex
, the platform MUST monitor and report ALL IPv4 and IPv6 addresses assigned to this network interface.
When mDNS is enabled:
- The platform MUST retrieve ALL currently assigned IPv4 and IPv6 addresses on the specified interface.
- For each retrieved address, the platform MUST call
otPlatMdnsHandleHostAddressEvent()
. - The IPv4 addresses are represented using IPv4-mapped IPv6 format.
Ongoing monitoring (while enabled):
- The platform MUST continuously monitor the specified interface for address changes.
- If any addresses are added or removed, the platform MUST call this callback for each affected address, indicating the change (addition or removal using
aAdded
).When mDNS is disabled: - The platform MUST cease monitoring for address changes on the interface.
- The platform does NOT need to explicitly signal the removal of addresses upon disable. The OpenThread stack automatically clears its internal address list.
- If address monitoring is re-enabled later, the platform MUST repeat the "enable" steps again, retrieving and reporting ALL current addresses.
The OpenThread stack maintains an internal list of host addresses. It updates this list automatically upon receiving calls to otPlatMdnsHandleHostAddressEvent()
.
- OpenThread's mDNS implementation uses a short guard time (4 msec) before taking action (e.g., announcing new addresses). This allows multiple changes to be grouped and announced together.
- OpenThread's mDNS implementation also handles transient changes, e.g., an address is removed and then quickly re-added. It ensures that announcements are only made when there is a change to the list (from what was announced before). This simplifies the platform's responsibility as it can simply report all observed changes.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
|
otPlatMdnsHandleReceive
void otPlatMdnsHandleReceive( otInstance *aInstance, otMessage *aMessage, bool aIsUnicast, const otPlatMdnsAddressInfo *aAddress )
Callback to notify OpenThread mDNS module of a received message on UDP port 5353.
aMessage
MUST contain DNS message starting with the DNS header at offset zero. This function passes the ownership of aMessage
from the platform layer to the OpenThread stack. The OpenThread stack will free the message once processed.
The aAddress
fields are as follows:
mAddress
specifies the sender's address. IPv4-mapped IPv6 format is used to represent an IPv4 destination.mPort
specifies the sender's port.mInfraIndex
specifies the interface index.
Details | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameters |
|
otPlatMdnsSendMulticast
void otPlatMdnsSendMulticast( otInstance *aInstance, otMessage *aMessage, uint32_t aInfraIfIndex )
Sends an mDNS message as multicast.
The platform MUST multicast the prepared mDNS message in aMessage
as a UDP message using the mDNS well-known port number 5353 for both source and destination ports. The message MUST be sent to the mDNS link-local multicast address 224.0.0.251
and/or its IPv6 equivalent ff02::fb
.
aMessage
contains the mDNS message starting with DNS header at offset zero. It does not include IP or UDP headers. This function passes the ownership of aMessage
to the platform layer and platform implementation MUST free aMessage
once sent and no longer needed.
The platform MUST allow multicast loopback, i.e., the multicast message aMessage
MUST also be received and passed back to OpenThread stack using otPlatMdnsHandleReceive()
callback. This behavior is essential for the OpenThread mDNS stack to process and potentially respond to its own queries, while allowing other mDNS receivers to also receive the query and its response.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
otPlatMdnsSendUnicast
void otPlatMdnsSendUnicast( otInstance *aInstance, otMessage *aMessage, const otPlatMdnsAddressInfo *aAddress )
Sends an mDNS message as unicast.
The platform MUST send the prepared mDNS message in aMessage
as a UDP message using source UDP port 5353 to the destination address and port number specified by aAddress
.
aMessage
contains the DNS message starting with the DNS header at offset zero. It does not include IP or UDP headers. This function passes the ownership of aMessage
to the platform layer and platform implementation MUST free aMessage
once sent and no longer needed.
The aAddress
fields are as follows:
mAddress
specifies the destination address. IPv4-mapped IPv6 format is used to represent an IPv4 destination.mPort
specifies the destination port.mInfraIndex
specifies the interface index.
If the matches this devices address, the platform MUST ensure to receive and pass the message back to the OpenThread stack using otPlatMdnsHandleReceive()
for processing.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
otPlatMdnsSetListeningEnabled
otError otPlatMdnsSetListeningEnabled( otInstance *aInstance, bool aEnable, uint32_t aInfraIfIndex )
Enables or disables listening for mDNS messages sent to mDNS port 5353.
When listening is enabled, the platform MUST listen for multicast messages sent to UDP destination port 5353 at the mDNS link-local multicast address 224.0.0.251
and its IPv6 equivalent ff02::fb
.
The platform SHOULD also listen for any unicast messages sent to UDP destination port 5353. If this is not possible, then OpenThread mDNS module can be configured to not use any "QU" questions requesting unicast response.
While enabled, all received messages MUST be reported back using otPlatMdnsHandleReceive()
callback.
When enabled, the platform MUST also monitor and report all IPv4 and IPv6 addresses assigned to the network interface using the otPlatMdnsHandleHostAddressEvent()
callback function. Refer to the documentation of this callback for detailed information on the callback's usage and parameters.
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.