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

// Copyright 2019, The Tari Project
//
// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
// following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
// disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
// following disclaimer in the documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
// products derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
// USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

// Much of this module is inspired or (more or less) verbatim from the Libra codebase.
// Copyright (c) The Libra Core Contributors
// SPDX-License-Identifier: Apache-2.0

use futures::{Future, Stream};
use multiaddr::Multiaddr;

mod dns;

mod memory;
pub use memory::MemoryTransport;

mod socks;
pub use socks::{SocksConfig, SocksTransport};

mod tcp;
pub use tcp::{TcpSocket, TcpTransport};

mod tcp_with_tor;
pub use tcp_with_tor::TcpWithTorTransport;

pub trait Transport {
    /// The output of the transport after a connection is established
    type Output;
    /// Transport error type
    type Error: std::error::Error + Send + Sync;
    /// A future which resolves to `Self::Output`
    type Inbound: Future<Output = Result<Self::Output, Self::Error>> + Send;
    /// A stream which emits `Self::InboundFuture` whenever a successful inbound connection is made
    type Listener: Stream<Item = Result<(Self::Inbound, Multiaddr), Self::Error>> + Send + Unpin;

    /// The future returned from the `listen` method.
    type ListenFuture: Future<Output = Result<(Self::Listener, Multiaddr), Self::Error>> + Send + Unpin;
    /// The future returned from the `dial` method.
    type DialFuture: Future<Output = Result<Self::Output, Self::Error>> + Send + Unpin;

    /// Listen for connections on the given multiaddr
    fn listen(&self, addr: Multiaddr) -> Result<Self::ListenFuture, Self::Error>;

    /// Connect (dial) to the given multiaddr
    fn dial(&self, addr: Multiaddr) -> Result<Self::DialFuture, Self::Error>;
}