Struct Connection

pub struct Connection<Si: Sink, St: Stream> { /* private fields */ }

A fully initialized connection with some peer.

Implementations

impl<Si: Sink, St: Stream> Connection<Si, St>

pub fn from_preestablished( sink: Si, stream: St, max_message_size: usize, cipher_send: ChaCha20Poly1305, cipher_recv: ChaCha20Poly1305, ) -> Self

Create a new connection from pre-established components.

This is useful in tests, or when upgrading a connection that has already been verified.

pub async fn upgrade_dialer<R: Rng + CryptoRng + Spawner + Clock, C: Signer>( context: R, config: Config<C>, sink: Si, stream: St, peer: C::PublicKey, ) -> Result<Self, Error>

Attempt to upgrade a raw connection we initiated as the dialer.

This implements the 3-message handshake protocol where the dialer:

1. Sends initial hello message to the listener
2. Receives listener response with hello + confirmation
3. Sends confirmation to the listener

pub async fn upgrade_listener<R: Rng + CryptoRng + Spawner + Clock, C: Signer>( context: R, incoming: IncomingConnection<C, Si, St>, ) -> Result<Self, Error>

Attempt to upgrade a connection we received as the listener.

This implements the last two steps of the 3-message handshake protocol. The first step, where the listener receives the dialer’s hello, is handled by IncomingConnection::verify.

The last two steps are: 2. Sends a response with hello + confirmation 3. Receives the dialer’s confirmation

pub fn split(self) -> (Sender<Si>, Receiver<St>)

Split the connection into a Sender and Receiver.

This pattern is commonly used to efficiently send and receive messages over the same connection concurrently.