mirror of
https://github.com/fluencelabs/rust-libp2p
synced 2025-05-19 14:11:20 +00:00
db82e0210e
Instead of relying on `protoc` and buildscripts, we generate the bindings using `pb-rs` and version them within our codebase. This makes for a better IDE integration, a faster build and an easier use of `rust-libp2p` because we don't force the `protoc` dependency onto them. Resolves #3024. Pull-Request: #3312.
76 lines
2.9 KiB
Rust
76 lines
2.9 KiB
Rust
// Copyright 2018 Parity Technologies (UK) Ltd.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a
|
|
// copy of this software and associated documentation files (the "Software"),
|
|
// to deal in the Software without restriction, including without limitation
|
|
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
|
// and/or sell copies of the Software, and to permit persons to whom the
|
|
// Software is furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
// DEALINGS IN THE SOFTWARE.
|
|
|
|
//! Implementation of the [Identify](https://github.com/libp2p/specs/blob/master/identify/README.md) protocol.
|
|
//!
|
|
//! This implementation of the protocol periodically exchanges
|
|
//! [`Info`] messages between the peers on an established connection.
|
|
//!
|
|
//! At least one identification request is sent on a newly established
|
|
//! connection, beyond which the behaviour does not keep connections alive.
|
|
//!
|
|
//! # Important Discrepancies
|
|
//!
|
|
//! - **Using Identify with other protocols** Unlike some other libp2p implementations,
|
|
//! rust-libp2p does not treat Identify as a core protocol. This means that other protocols cannot
|
|
//! rely upon the existence of Identify, and need to be manually hooked up to Identify in order to
|
|
//! make use of its capabilities.
|
|
//!
|
|
//! # Usage
|
|
//!
|
|
//! The [`Behaviour`] struct implements a [`NetworkBehaviour`](libp2p_swarm::NetworkBehaviour)
|
|
//! that negotiates and executes the protocol on every established connection, emitting
|
|
//! [`Event`]s.
|
|
|
|
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
|
|
|
|
pub use self::behaviour::{Behaviour, Config, Event};
|
|
pub use self::protocol::{Info, UpgradeError, PROTOCOL_NAME, PUSH_PROTOCOL_NAME};
|
|
|
|
#[deprecated(
|
|
since = "0.40.0",
|
|
note = "Use re-exports that omit `Identify` prefix, i.e. `libp2p_identify::Config`"
|
|
)]
|
|
pub type IdentifyConfig = Config;
|
|
|
|
#[deprecated(
|
|
since = "0.40.0",
|
|
note = "Use re-exports that omit `Identify` prefix, i.e. `libp2p_identify::Event`"
|
|
)]
|
|
pub type IdentifyEvent = Event;
|
|
|
|
#[deprecated(since = "0.40.0", note = "Use libp2p_identify::Behaviour instead.")]
|
|
pub type Identify = Behaviour;
|
|
|
|
#[deprecated(
|
|
since = "0.40.0",
|
|
note = "Use re-exports that omit `Identify` prefix, i.e. `libp2p_identify::Info`"
|
|
)]
|
|
pub type IdentifyInfo = Info;
|
|
|
|
mod behaviour;
|
|
mod handler;
|
|
mod protocol;
|
|
|
|
mod proto {
|
|
include!("generated/mod.rs");
|
|
pub use self::structs::Identify;
|
|
}
|