Struct gossip::GossipService

pub struct GossipService<T> { /* fields omitted */ }

The gossip service

Implementations

impl<T> GossipService<T> where
    T: UpdateHandler + 'static + Send, 

pub fn new(
    address: SocketAddr,
    peer_sampling_config: PeerSamplingConfig,
    gossip_config: GossipConfig
) -> GossipService<T>

Creates a new gossiping service

Arguments

• address - Socket address of the node
• peer_sampling_config - Configuration for peer sampling, see PeerSamplingConfig
• gossip_config - Configuration for gossiping, see GossipConfig

pub fn new_with_defaults(address: SocketAddr) -> Self

Create a gossip service with default configurations

Arguments

• address - Socket address of the node

pub fn address(&self) -> &SocketAddr

Returns the node address

pub fn peers(&self) -> Vec<Peer>

Returns a list of the node's peer

pub fn start(
    &mut self,
    peer_sampling_init: Box<dyn FnOnce() -> Option<Vec<Peer>>>,
    update_handler: Box<T>
) -> Result<(), Box<dyn Error>>

Starts the gossip protocol and related threads

Arguments

• peer_sampling_init - Closure for retrieving the address of the first peer to contact
• update_handler - Application callback for receiving new updates

pub fn submit(&self, bytes: Vec<u8>) -> Result<(), Box<dyn Error>>

Submits a message for broadcast by the gossip protocol

Arguments

• bytes - Content of the message

pub fn is_active(&self, bytes: Vec<u8>) -> bool

pub fn is_expired(&self, bytes: Vec<u8>) -> bool

pub fn shutdown(&mut self) -> Result<(), Box<dyn Error>>

Terminates the gossip protocol and related threads