gossip 0.0.3

A generic gossip library that uses gossip-based peer sampling
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

use std::fmt::Debug;
use serde::{Serialize, Deserialize};
use crate::peer::Peer;
use crate::message::{self, Message, MESSAGE_PROTOCOL_SAMPLING_MESSAGE};

/// A peer sampling protocol message
#[derive(Debug, Serialize, Deserialize)]
pub struct PeerSamplingMessage {
    /// Address of the sender
    sender: String,
    /// Type of the message
    message_type: message::MessageType,
    /// The view of the sender
    view: Option<Vec<Peer>>,
}

impl PeerSamplingMessage {
    /// Creates a new message of type [MessageType::Request] containing a view
    pub fn new_request(sender: String, view: Option<Vec<Peer>>) -> Self {
        Self::new(sender, message::MessageType::Request, view)
    }

    /// Creates a new message of type [MessageType::Response] containing a view
    pub fn new_response(sender: String, view: Option<Vec<Peer>>) -> Self {
        Self::new(sender, message::MessageType::Response, view)
    }

    fn new(sender: String, message_type: message::MessageType, view: Option<Vec<Peer>>) -> Self {
        Self {
            sender,
            message_type,
            view
        }
    }

    /// Returns the message sender
    pub fn sender(&self) -> &str {
        &self.sender
    }

    /// Returns the message type
    pub fn message_type(&self) -> &message::MessageType {
        &self.message_type
    }

    /// Returns the view contained in the message
    pub fn view(&self) -> &Option<Vec<Peer>> {
        &self.view
    }
}

impl Message for PeerSamplingMessage {
    fn protocol(&self) -> u8 {
        MESSAGE_PROTOCOL_SAMPLING_MESSAGE
    }
}