Struct Connection

struct Connection<Out, In> {
    msg_tx: Sender<Out>,
    msg_rx: Receiver<In>,
    error_rx: Receiver<String>,
    _tasks: [AbortOnDropHandle<()>; 2],
}

An active CTP connection.

This type encapsulates the core connection logic. It is used by both the client and the server implementation, with swapped Out/In types.

Each connection spawns two tasks:

• The send task is responsible for encoding and sending enqueued messages.
• The recv task is responsible for receiving and decoding messages from the peer.

The separation into tasks provides some performance isolation between the sending and the receiving half of the connection.

Fields

msg_tx: Sender<Out>

Message sender connected to the send task.

msg_rx: Receiver<In>

Message receiver connected to the receive task.

error_rx: Receiver<String>

Receiver for errors encountered by connection tasks.

_tasks: [AbortOnDropHandle<()>; 2]

Handles to connection tasks.

Implementations

impl<Out: Message, In: Message> Connection<Out, In>

const KEEPALIVE_INTERVAL: Duration

The interval with which keepalives are emitted on idle connections.

const MIN_TIMEOUT: Duration

The minimum acceptable idle timeout.

We want this to be significantly greater than KEEPALIVE_INTERVAL, to avoid connections getting canceled unnecessarily.

async fn start( stream: Stream, version: Version, server_fqdn: Option<String>, timeout: Duration, metrics: impl Metrics<Out, In>, ) -> Result<Self>

Start a new connection wrapping the given stream.

async fn send(&mut self, msg: Out) -> Result<()>

Enqueue a message for sending.

async fn recv(&mut self) -> Result<In>

Return a received message.

Cancel safety

This method is cancel safe.

async fn collect_error(&mut self) -> String

Return a connection error.

async fn run_send_task<W: AsyncWrite + Unpin>( writer: W, msg_rx: Receiver<Out>, error_tx: Sender<String>, metrics: impl Metrics<Out, In>, )

Run a connection’s send task.

async fn run_recv_task<R: AsyncRead + Unpin>( reader: R, msg_tx: Sender<In>, error_tx: Sender<String>, metrics: impl Metrics<Out, In>, )

Run a connection’s recv task.

Trait Implementations

impl<Out: Debug, In: Debug> Debug for Connection<Out, In>

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

Formats the value using the given formatter.