Struct snarkos_node_tcp::Tcp

pub struct Tcp(/* private fields */);

The central object responsible for handling connections.

Implementations

impl Tcp

pub fn new(config: Config) -> Self

Creates a new Tcp using the given Config.

pub fn name(&self) -> &str

Returns the name assigned.

pub fn config(&self) -> &Config

Returns a reference to the configuration.

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

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

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

Checks whether the provided address is connected.

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

Checks if Tcp is currently setting up a connection with the provided address.

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 fn connected_addrs(&self) -> Vec<SocketAddr>

Returns a list containing addresses of active connections.

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

Returns a list containing addresses of pending connections.

pub fn known_peers(&self) -> &KnownPeers

Returns a reference to the collection of statistics of known peers.

pub fn stats(&self) -> &Stats

Returns a reference to the statistics.

pub fn span(&self) -> &Span

Returns the tracing Span associated with Tcp.

pub async fn shut_down(&self)

Gracefully shuts down the stack.

impl Tcp

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.

impl Tcp

pub async fn enable_listener(&self) -> Result<SocketAddr>

Spawns a task that listens for incoming connections.

Trait Implementations

impl Clone for Tcp

fn clone(&self) -> Tcp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tcp

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

Formats the value using the given formatter.

impl Deref for Tcp

type Target = Arc<InnerTcp>

The resulting type after dereferencing.

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

Dereferences the value.