Struct gossip::PeerSamplingConfig

pub struct PeerSamplingConfig { /* fields omitted */ }

The peer sampling parameters

See: Gossip-based Peer Sampling

Implementations

impl PeerSamplingConfig

pub fn new(
    push: bool,
    pull: bool,
    sampling_period: u64,
    view_size: usize,
    healing_factor: usize,
    swapping_factor: usize
) -> Self

Create a new peer sampling configuration

Arguments

• push - Does the node push its view to other peers
• pull - When active, if the node will pull views from other peers; when passive, if it responds with its view to push requests
• sampling_period - The interval between each cycle of push/pull
• view_size - The number of peers in the view of the node
• healing_factor - The number of removal at each cycle
• swapping_factor - The number of peer swapped at each cycle

pub fn new_with_deviation(
    push: bool,
    pull: bool,
    sampling_period: u64,
    sampling_deviation: u64,
    view_size: usize,
    healing_factor: usize,
    swapping_factor: usize
) -> Self

Creates a new configuration with the possibility to randomize the period; this is useful when testing locally in order to avoid network saturation

Arguments

• sampling_deviation - The maximum value of the random value added to the period

pub fn sampling_period(&self) -> u64

pub fn sampling_deviation(&self) -> u64

pub fn healing_factor(&self) -> usize

pub fn swapping_factor(&self) -> usize

pub fn view_size(&self) -> usize

pub fn is_pull(&self) -> bool

pub fn is_push(&self) -> bool

Trait Implementations

impl Clone for PeerSamplingConfig

pub fn clone(&self) -> PeerSamplingConfig

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for PeerSamplingConfig

pub fn default() -> Self

Returns the "default value" for a type.