libp2p_mdns/lib.rs
1// Copyright 2018 Parity Technologies (UK) Ltd.
2//
3// Permission is hereby granted, free of charge, to any person obtaining a
4// copy of this software and associated documentation files (the "Software"),
5// to deal in the Software without restriction, including without limitation
6// the rights to use, copy, modify, merge, publish, distribute, sublicense,
7// and/or sell copies of the Software, and to permit persons to whom the
8// Software is furnished to do so, subject to the following conditions:
9//
10// The above copyright notice and this permission notice shall be included in
11// all copies or substantial portions of the Software.
12//
13// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
14// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
18// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
19// DEALINGS IN THE SOFTWARE.
20
21//! mDNS is a protocol defined by [RFC 6762](https://tools.ietf.org/html/rfc6762) that allows
22//! querying nodes that correspond to a certain domain name.
23//!
24//! In the context of libp2p, the mDNS protocol is used to discover other nodes on the local
25//! network that support libp2p.
26//!
27//! # Usage
28//!
29//! This crate provides the `Mdns` struct which implements the `NetworkBehaviour` trait. This
30//! struct will automatically discover other libp2p nodes on the local network.
31//!
32
33/// The DNS service name for all libp2p peers used to query for addresses.
34const SERVICE_NAME: &[u8] = b"_p2p._udp.local";
35/// The meta query for looking up the `SERVICE_NAME`.
36const META_QUERY_SERVICE: &[u8] = b"_services._dns-sd._udp.local";
37
38pub use crate::behaviour::{Mdns, MdnsConfig, MdnsEvent};
39
40mod behaviour;
41mod dns;
42mod query;