Struct bee_protocol_types::peer::Peer

pub struct Peer { /* private fields */ }

A type holding information related to a peer.

Implementations

impl Peer

pub fn new(id: PeerId, info: PeerInfo) -> Self

Creates a new Peer.

pub fn id(&self) -> &PeerId

Returns the identifier of the Peer.

pub fn address(&self) -> &Multiaddr

Returns the address of the Peer.

pub fn alias(&self) -> &String

Returns the alias of the Peer.

pub fn relation(&self) -> PeerRelation

Returns the relationship kind of the Peer.

pub fn set_connected(&self, connected: bool)

Returns whether the Peer is connected or not.

pub fn is_connected(&self) -> bool

Sets whether the Peer is connected or not.

pub fn metrics(&self) -> &PeerMetrics

Returns the metrics of the Peer.

pub fn set_solid_milestone_index(&self, index: MilestoneIndex)

Sets the solid milestone index of the Peer.

pub fn solid_milestone_index(&self) -> MilestoneIndex

Returns the solid milestone index of the Peer.

pub fn set_pruned_index(&self, index: MilestoneIndex)

Sets the pruned index of the Peer.

pub fn pruned_index(&self) -> MilestoneIndex

Returns the pruned index of the Peer.

pub fn set_latest_milestone_index(&self, index: MilestoneIndex)

Sets the latest milestone index of the Peer.

pub fn latest_milestone_index(&self) -> MilestoneIndex

Returns the latest milestone index of the Peer.

pub fn set_connected_peers(&self, connected_peers: u8)

Sets the number of connected peers of the Peer.

pub fn connected_peers(&self) -> u8

Returns the number of connected peers of the Peer.

pub fn set_synced_peers(&self, synced_peers: u8)

Sets the number of synced peers of the Peer.

pub fn synced_peers(&self) -> u8

Returns the number of synced peers of the Peer.

pub fn set_heartbeat_sent_timestamp(&self)

Sets the timestamp of the last heartbeat sent by the Peer.

pub fn heartbeat_sent_timestamp(&self) -> u64

Returns the timestamp of the last heartbeat sent by the Peer.

pub fn set_heartbeat_received_timestamp(&self)

Sets the timestamp of the last heartbeat received by the Peer.

pub fn heartbeat_received_timestamp(&self) -> u64

Returns the timestamp of the last heartbeat received by the Peer.

pub fn is_synced(&self) -> bool

Returns whether the Peer is synced or not.

pub fn is_synced_threshold(&self, threshold: u32) -> bool

Returns whether the Peer is synced with a threshold or not.

pub fn has_data(&self, index: MilestoneIndex) -> bool

Returns whether the Peer has the data referenced by a given milestone index.

pub fn maybe_has_data(&self, index: MilestoneIndex) -> bool

Returns whether the Peer may have the data referenced by a given milestone index.