Struct pea2pea::Node

pub struct Node(_);

The central object responsible for handling all the connections.

Implementations

impl Node

pub async fn new(config: Option<Config>) -> Result<Self>

Creates a new Node optionally using a given Config.

pub fn name(&self) -> &str

Returns the name assigned to the node.

pub fn config(&self) -> &Config

Returns a reference to the node’s config.

pub fn stats(&self) -> &Stats

Returns a reference to the node’s stats.

pub fn span(&self) -> &Span

Returns the tracing Span associated with the node.

pub fn listening_addr(&self) -> Result<SocketAddr>

Returns the node’s listening address; returns an error if the node was configured to not listen for inbound connections.

pub async fn connect(&self, addr: SocketAddr) -> Result<()>

Connects to the provided SocketAddr.

pub async fn disconnect(&self, addr: SocketAddr) -> bool

Disconnects from the provided SocketAddr.

pub fn connected_addrs(&self) -> Vec<SocketAddr>

Returns a list containing addresses of active connections.

pub fn known_peers(&self) -> &KnownPeers

Returns a reference to the collection of statistics of node’s known peers.

pub fn is_connected(&self, addr: SocketAddr) -> bool

Checks whether the provided address is connected.

pub fn num_connected(&self) -> usize

Returns the number of active connections.

pub fn num_connecting(&self) -> usize

Returns the number of connections that are currently being set up.

pub async fn shut_down(&self)

Gracefully shuts the node down.

Trait Implementations

impl Clone for Node

fn clone(&self) -> Node

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for Node

type Target = Arc<InnerNode>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.