mirror of
https://github.com/fluencelabs/rust-libp2p
synced 2025-05-15 04:11:19 +00:00
d4f8ec2d48
* misc/metrics: Explicitly delegate event recording to each recorder
This allows delegating a single event to multiple `Recorder`s. That enables e.g. the
`identify::Metrics` `Recorder` to act both on `IdentifyEvent` and `SwarmEvent`. The latter enables
it to garbage collect per peer data on disconnects.
* protocols/dcutr: Expose PROTOCOL_NAME
* protocols/identify: Expose PROTOCOL_NAME and PUSH_PROTOCOL_NAME
* protocols/ping: Expose PROTOCOL_NAME
* protocols/relay: Expose HOP_PROTOCOL_NAME and STOP_PROTOCOL_NAME
* misc/metrics: Track # connected nodes supporting specific protocol
An example metric exposed with this patch:
```
libp2p_identify_protocols{protocol="/ipfs/ping/1.0.0"} 10
```
This implies that 10 of the currently connected nodes support the ping protocol.
57 lines
2.4 KiB
Rust
57 lines
2.4 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] protocol.
|
|
//!
|
|
//! This implementation of the protocol periodically exchanges
|
|
//! [`IdentifyInfo`] 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 [`Identify`] struct implements a `NetworkBehaviour` that negotiates
|
|
//! and executes the protocol on every established connection, emitting
|
|
//! [`IdentifyEvent`]s.
|
|
//!
|
|
//! [Identify]: https://github.com/libp2p/specs/tree/master/identify
|
|
//! [`Identify`]: self::Identify
|
|
//! [`IdentifyEvent`]: self::IdentifyEvent
|
|
//! [`IdentifyInfo`]: self::IdentifyInfo
|
|
|
|
pub use self::identify::{Identify, IdentifyConfig, IdentifyEvent};
|
|
pub use self::protocol::{IdentifyInfo, UpgradeError, PROTOCOL_NAME, PUSH_PROTOCOL_NAME};
|
|
|
|
mod handler;
|
|
mod identify;
|
|
mod protocol;
|
|
|
|
mod structs_proto {
|
|
include!(concat!(env!("OUT_DIR"), "/structs.rs"));
|
|
}
|