volans-ping 0.2.0

Ping protocol for volans
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

pub mod inbound;
pub mod outbound;
mod protocol;

use std::time::Duration;

use volans_core::PeerId;
use volans_swarm::ConnectionId;

#[derive(Debug, Clone)]
pub struct Config {
    timeout: Duration,
    interval: Duration,
    failures: u32,
}

impl Default for Config {
    fn default() -> Self {
        Self {
            timeout: Duration::from_secs(1),
            interval: Duration::from_secs(10),
            failures: 3,
        }
    }
}

#[derive(Debug, thiserror::Error)]
pub enum Failure {
    #[error("Ping timeout")]
    Timeout,
    #[error("Ping protocol not supported")]
    Unsupported,
    #[error("Ping protocol error: {error}")]
    Other {
        error: Box<dyn std::error::Error + Send + Sync + 'static>,
    },
}

impl Failure {
    fn other(e: impl std::error::Error + Send + Sync + 'static) -> Self {
        Self::Other { error: Box::new(e) }
    }
}

#[derive(Debug)]
pub struct Event {
    pub connection: ConnectionId,
    pub peer_id: PeerId,
    pub result: Result<Duration, Failure>,
}