Struct pea2pea::Node

pub struct Node {
    pub config: NodeConfig,
    pub listening_addr: SocketAddr,
    pub stats: NodeStats,
    // some fields omitted
}

The central object responsible for handling all the connections.

Fields

config: NodeConfig

The node's configuration.

listening_addr: SocketAddr

The node's listening address.

stats: NodeStats

Collects statistics related to the node itself.

Implementations

impl Node

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

Returns a Node wrapped in an Arc.

pub fn name(&self) -> &str

Returns the name assigned to the node.

pub fn span(&self) -> &Span

Returns the tracing Span associated with the node.

pub async fn initiate_connection(
    self: &Arc<Self>,
    addr: SocketAddr
) -> Result<()>

Connects to the provided SocketAddr.

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

Disconnects from the provided SocketAddr.

pub async fn send_direct_message(
    &self,
    addr: SocketAddr,
    message: Bytes
) -> Result<()>

Sends the provided message to the specified SocketAddr, as long as the Writing protocol is enabled.

pub async fn send_broadcast(&self, message: Bytes) -> Result<()>

Broadcasts the provided message to all peers, as long as the Writing protocol is enabled.

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 reading_handler(&self) -> Option<&ReadingHandler>

Returns a reference to the reading handler, if the Reading protocol is enabled.

pub fn writing_handler(&self) -> Option<&WritingHandler>

Returns a reference to the writing handler, if the Writing protocol is enabled.

pub fn set_handshake_handler(&self, handler: HandshakeHandler)

Sets up the handshake handler, as part of the Handshaking protocol.

pub fn set_reading_handler(&self, handler: ReadingHandler)

Sets up the reading handler, as part of enabling the Reading protocol.

pub fn set_writing_handler(&self, handler: WritingHandler)

Sets up the writing handler, as part of enabling the Writing protocol.