Struct Connection

pub struct Connection { /* private fields */ }

A connection is a group of streams that span from one node to another on the circuit network.

When we establish a network of circuit nodes, we can create a stream from any one to any other. These streams are independent, however; they have no name or identifier, nor anything else by which you might group them.

A Connection is a link from a node to a peer that we can obtain streams from, just as we can from the Node itself, but the streams have IDs which are in a namespace unique to the connection. Multiple connections can exist per node, and each sees only the streams related to itself.

There’s a small bit of added protocol associated with this, so there will be some change to traffic on the wire.

Implementations

impl Connection

pub async fn bind_stream(&self, id: u64) -> Option<(Reader, Writer)>

pub fn from(&self) -> &str

pub async fn alloc_stream(&self, reader: Reader, writer: Writer) -> Result<u64>

Create a new stream to the other end of this connection.

pub fn is_client(&self) -> bool

Whether this connection is a client (initiated by another node) as opposed to a server (initiated by this node).

Trait Implementations

impl Clone for Connection

fn clone(&self) -> Connection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Connection

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

Formats the value using the given formatter.