pea2pea 0.7.0

a simple P2P library
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

use crate::{Connection, ConnectionReader, Pea2Pea};

use tokio::sync::{mpsc, oneshot};

use std::io;

/// This protocol can be used to specify and enable network handshakes. Upon establishing a connection, both sides will
/// need to adhere to the specified handshake rules in order to finalize the connection and be able to transmit any
/// messages.
pub trait Handshaking: Pea2Pea {
    /// Prepares the node to produce and handle network handshakes.
    fn enable_handshaking(&self);
}

/// A set of objects required to perform handshakes.
pub type HandshakeObjects = (
    ConnectionReader,
    Connection,
    oneshot::Sender<io::Result<(ConnectionReader, Connection)>>,
);

/// An object dedicated to handling connection handshakes; used in the `Handshaking` protocol.
pub struct HandshakeHandler(mpsc::Sender<HandshakeObjects>);

impl HandshakeHandler {
    /// Sends handshake-relevant objects to the handshake handler.
    pub async fn send(&self, handshake_objects: HandshakeObjects) {
        if self.0.send(handshake_objects).await.is_err() {
            // can't recover if this happens
            panic!("the handshake handling task is down or its Receiver is closed")
        }
    }
}

impl From<mpsc::Sender<HandshakeObjects>> for HandshakeHandler {
    fn from(sender: mpsc::Sender<HandshakeObjects>) -> Self {
        Self(sender)
    }
}