Struct plumtree::Node

pub struct Node<T: System> { /* fields omitted */ }

Plumtree node.

Methods

impl<T: System> Node<T>

pub fn new(node_id: T::NodeId) -> Self

Makes a new Node instance.

pub fn with_options(node_id: T::NodeId, options: NodeOptions) -> Self

Makes a new Node instance with the given options.

pub fn id(&self) -> &T::NodeId

Returns the identifier of the node.

pub fn options(&self) -> &NodeOptions

Returns the options of the node.

pub fn eager_push_peers(&self) -> &HashSet<T::NodeId>

Returns the peers with which the node uses eager push gossip for diffusing application messages.

pub fn lazy_push_peers(&self) -> &HashSet<T::NodeId>

Returns the peers with which the node uses lazy push gossip for diffusing application messages.

pub fn broadcast_message(&mut self, message: Message<T>)

Broadcasts the given message.

pub fn messages(&self) -> &HashMap<T::MessageId, T::MessagePayload>

Returns a reference to the messages kept by the node.

pub fn forget_message(&mut self, message_id: &T::MessageId) -> bool

Forgets the specified message.

If the node does not have the target message, this method will return false.

For preventing memory shortage, this method needs to be called appropriately.

pub fn poll_action(&mut self) -> Option<Action<T>>

Polls the next action that the node wants to execute.

pub fn handle_protocol_message(&mut self, message: ProtocolMessage<T>)

Handles the given incoming message.

pub fn handle_neighbor_up(&mut self, neighbor_node_id: &T::NodeId)

Accepts new neighbor.

pub fn handle_neighbor_down(&mut self, neighbor_node_id: &T::NodeId)

Removes downed neighbor.

pub fn tick(&mut self)

Advances the logical time of the node by one unit.

Trait Implementations

impl<T: System> Debug for Node<T> where     T::NodeId: Debug,     T::MessageId: Debug,     T::MessagePayload: Debug,

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

Formats the value using the given formatter.