1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

// 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.

//! Provides the `TransportExt` trait.

#[allow(deprecated)]
use crate::bandwidth::{BandwidthLogging, BandwidthSinks};
use crate::core::{
    muxing::{StreamMuxer, StreamMuxerBox},
    transport::Boxed,
};
use crate::Transport;
use libp2p_identity::PeerId;
use std::sync::Arc;

/// Trait automatically implemented on all objects that implement `Transport`. Provides some
/// additional utilities.
pub trait TransportExt: Transport {
    /// Adds a layer on the `Transport` that logs all trafic that passes through the streams
    /// created by it.
    ///
    /// This method returns an `Arc<BandwidthSinks>` that can be used to retrieve the total number
    /// of bytes transferred through the streams.
    ///
    /// # Example
    ///
    /// ```
    /// use libp2p_yamux as yamux;
    /// use libp2p_noise as noise;
    /// use libp2p_tcp as tcp;
    /// use libp2p::{
    ///     core::upgrade,
    ///     identity,
    ///     TransportExt,
    ///     Transport,
    /// };
    ///
    /// let id_keys = identity::Keypair::generate_ed25519();
    ///
    /// let transport = tcp::tokio::Transport::new(tcp::Config::default().nodelay(true))
    ///     .upgrade(upgrade::Version::V1)
    ///     .authenticate(
    ///         noise::Config::new(&id_keys)
    ///             .expect("Signing libp2p-noise static DH keypair failed."),
    ///     )
    ///     .multiplex(yamux::Config::default())
    ///     .boxed();
    ///
    /// let (transport, sinks) = transport.with_bandwidth_logging();
    /// ```
    #[allow(deprecated)]
    #[deprecated(
        note = "Use `libp2p::SwarmBuilder::with_bandwidth_metrics` or `libp2p_metrics::BandwidthTransport` instead."
    )]
    fn with_bandwidth_logging<S>(self) -> (Boxed<(PeerId, StreamMuxerBox)>, Arc<BandwidthSinks>)
    where
        Self: Sized + Send + Unpin + 'static,
        Self::Dial: Send + 'static,
        Self::ListenerUpgrade: Send + 'static,
        Self::Error: Send + Sync,
        Self::Output: Into<(PeerId, S)>,
        S: StreamMuxer + Send + 'static,
        S::Substream: Send + 'static,
        S::Error: Send + Sync + 'static,
    {
        let sinks = BandwidthSinks::new();
        let sinks_copy = sinks.clone();
        let transport = Transport::map(self, |output, _| {
            let (peer_id, stream_muxer_box) = output.into();
            (
                peer_id,
                StreamMuxerBox::new(BandwidthLogging::new(stream_muxer_box, sinks_copy)),
            )
        })
        .boxed();
        (transport, sinks)
    }
}

impl<TTransport> TransportExt for TTransport where TTransport: Transport {}