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( dialer: bool, sink: Si, stream: St, cipher: ChaCha20Poly1305, max_message_size: usize, ) -> 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: Scheme>( context: R, config: Config<C>, sink: Si, stream: St, peer: C::PublicKey, ) -> Result<Self, Error>

Attempt to upgrade a raw connection we initiated.

This will send a handshake message to the peer, wait for a response, and verify the peer’s handshake message.

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

Attempt to upgrade a connection initiated by some peer.

Because we already verified the peer’s handshake, this function only needs to send our handshake message for the connection to be fully initialized.

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.