Struct Connection 

pub struct Connection { /* private fields */ }

A live connection to one agent. Dropping it closes the connection; the agent keeps running.

Implementations

impl Connection

pub fn open(stream: TcpStream, config: HostConfig) -> Result<Connection>

Starts a host session over stream, which the agent speaks first on.

pub fn handshake( &self, timeout: Duration, ) -> Result<Negotiated, DisconnectReason>

Waits until the handshake completes, or fails with the reason the session closed: a refused hello (another token, no common protocol version), silence past the peer timeout, or the end of the stream. timeout caps the wait; past it the connection is closed and the failure is silence.

pub fn negotiated(&self) -> Option<Negotiated>

What the handshake settled, once it has.

pub fn call(&self, call: Call, deadline: Duration) -> Result<Reply, Error>

Sends call with deadline and waits for its answer: the agent’s, or the session’s own deadline_exceeded or disconnected error.

pub fn resync(&self, stream: Stream) -> Result<u32, Error>

Asks the agent to resynchronize stream; the outcome reaches the sink as Resynced or ResyncFailed.

pub fn set_sink(&self, sink: EventSink)

Sets where events go from now on, after replaying those that arrived while no sink was set.

pub fn close_reason(&self) -> Option<DisconnectReason>

Why the connection closed, once it has.

pub fn is_closed(&self) -> bool

pub fn close(&self)

Closes the connection from this side, failing pending calls.

Trait Implementations

impl Drop for Connection

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.