Struct poldercast::poldercast::Vicinity

pub struct Vicinity { /* fields omitted */ }

The Vicinity module is responsible for maintaining interest-induced random links, that is, randomly chosen links between nodes that share one or more topics. Such links serve as input to the Rings module. Additionally, they are used by the dissemination protocol to propagate events to arbitrary subscribers of a topic.

Implementations

impl Vicinity

pub fn new(max_view_size: usize, max_gossip_length: usize) -> Self

Trait Implementations

impl Clone for Vicinity

fn clone(&self) -> Vicinity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vicinity

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Vicinity

fn default() -> Self

Returns the "default value" for a type.

impl Layer for Vicinity

fn alias(&self) -> &'static str

alias to the layer, for information purpose

fn reset(&mut self)

reset the layer state

fn populate(&mut self, identity: &NodeProfile, all_nodes: &Nodes)

populate the Layer based on all the nodes. The NodeProfile is given as the identity of the local node, allowing access to the local PublicId or Subscriptions (for example, used in the Rings or Vicinity module).

fn gossips(
    &mut self,
    _identity: &NodeProfile,
    gossips_builder: &mut GossipsBuilder,
    all_nodes: &Nodes
)

update the GossipsBuilder, effectively preparing the list of gossips to share with the recipient (see GossipsBuilder). To build the gossips the Layer has access to the whole list of known Nodes.

fn view(&mut self, view_builder: &mut ViewBuilder, all_nodes: &mut Nodes)

based on the populated layer, provide nodes to the ViewBuilder.