Home

Awesome

mdns-sd

Build Cargo docs.rs Rust version: 1.63+

This is a small implementation of mDNS (Multicast DNS) based service discovery in safe Rust, with a small set of dependencies. Some highlights:

Approach

We are not using async/.await internally, instead we create a new thread to run a mDNS daemon.

The API interacts with the daemon via flume channels that work easily with both sync and async code. For more details, please see the documentation.

Compatibility and Limitations

This implementation is based on the following RFCs:

This is still beta software. We focus on the common use cases at hand. And we tested with some existing common tools (e.g. Avahi on Linux, dns-sd on MacOS, and Bonjour library on iOS) to verify the basic compatibility.

The following table shows how much this implementation is compliant with RFCs regarding major features:

FeatureRFC sectionComplianceNotes
One-Shot Multicast DNS Queries (i.e. Legacy Unicast Responses)RFC 6762 section 5.1 section 6.7because we don't support Unicast yet.
Unicast ResponsesRFC 6762 section 5.4
Known-Answer SuppressionRFC 6762 section 7.1
Multipacket Known Answer Suppression querierRFC 6762 section 7.2
Multipacket Known Answer Suppression responderRFC 6762 section 7.2because we don't support Unicast yet.
ProbingRFC 6762 section 8.1
Simultaneous Probe TiebreakingRFC 6762 section 8.2
Conflict ResolutionRFC 6762 section 9see DnsNameChange type
Goodbye PacketsRFC 6762 section 10.1
Announcements to Flush Outdated Cache EntriesRFC 6762 section 10.2i.e. cache-flush bit
Cache Flush on Failure IndicationRFC 6762 section 10.4API: ServiceDaemon::verify()

License

Licensed under either of

at your option.

Contribution

Contributions are welcome! Please open an issue in GitHub if any questions.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the above license(s), shall be dual licensed as above, without any additional terms or conditions.