tet_libp2p_identify/
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//! Implementation of the [Identify] protocol.
22//!
23//! This implementation of the protocol periodically exchanges
24//! [`IdentifyInfo`] messages between the peers on an established connection.
25//!
26//! At least one identification request is sent on a newly established
27//! connection, beyond which the behaviour does not keep connections alive.
28//!
29//! # Usage
30//!
31//! The [`Identify`] struct implements a `NetworkBehaviour` that negotiates
32//! and executes the protocol on every established connection, emitting
33//! [`IdentifyEvent`]s.
34//!
35//! [Identify]: https://github.com/libp2p/specs/tree/master/identify
36//! [`Identify`]: self::Identify
37//! [`IdentifyEvent`]: self::IdentifyEvent
38//! [`IdentifyInfo`]: self::IdentifyEvent
39
40pub use self::identify::{Identify, IdentifyEvent};
41pub use self::protocol::IdentifyInfo;
42
43mod handler;
44mod identify;
45mod protocol;
46
47mod structs_proto {
48    include!(concat!(env!("OUT_DIR"), "/structs.rs"));
49}
50
tet_libp2p_identify/lib.rs

tet_libp2p_identify/
lib.rs
