tari_comms 5.2.1

A peer-to-peer messaging system
Documentation 
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

// 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.
//! # ConnectionManager
//!
//! This component is responsible for orchestrating PeerConnections, specifically:
//! - dialing peers,
//! - listening for peer connections on the configured transport,
//! - performing connection upgrades (noise protocol, identity and multiplexing),
//! - and, notifying the connectivity manager of changes in connection state (new connections, disconnects, etc)

mod dial_state;
mod dialer;
mod listener;
#[cfg(feature = "metrics")]
mod metrics;

mod common;
pub use common::PeerConnectionInfo;

mod direction;
pub use direction::ConnectionDirection;

mod requester;
pub use requester::{ConnectionManagerRequest, ConnectionManagerRequester};

mod manager;
pub(crate) use manager::ConnectionManager;
pub use manager::{ConnectionManagerConfig, ConnectionManagerEvent, ListenerInfo};

mod error;
pub use error::{ConnectionManagerError, PeerConnectionError};

mod peer_connection;
pub use peer_connection::{ConnectionId, NegotiatedSubstream, PeerConnection, PeerConnectionRequest};

mod self_liveness;
pub(crate) use self_liveness::SelfLivenessCheck;
pub use self_liveness::SelfLivenessStatus;

mod wire_mode;
pub use wire_mode::WireMode;

#[cfg(test)]
mod tests;