Struct SessionHandle 

pub struct SessionHandle { /* private fields */ }

Cloneable handle for opening and closing virtual connections.

Returned by the session builder alongside the Session and root ConnectionHandle. The session’s run() loop must be running concurrently for requests to be processed.

Implementations

impl SessionHandle

pub async fn open_connection( &self, settings: ConnectionSettings, metadata: Metadata<'static>, ) -> Result<ConnectionHandle, SessionError>

Open a new virtual connection on the session.

Allocates a connection ID, sends ConnectionOpen to the peer, and waits for ConnectionAccept or ConnectionReject. The session’s run() loop processes the response and completes the returned future.

pub async fn close_connection( &self, conn_id: ConnectionId, metadata: Metadata<'static>, ) -> Result<(), SessionError>

Close a virtual connection.

Sends ConnectionClose to the peer and removes the connection slot. After this returns, no further messages will be routed to the connection’s driver.

pub async fn resume<I: IntoConduit>( &self, into_conduit: I, handshake_result: HandshakeResult, ) -> Result<(), SessionError>

where I::Conduit: Conduit<Msg = MessageFamily> + 'static, <I::Conduit as Conduit>::Tx: MaybeSend + MaybeSync + 'static, for<'p> <<I::Conduit as Conduit>::Tx as ConduitTx>::Permit<'p>: MaybeSend, <I::Conduit as Conduit>::Rx: MaybeSend + 'static,

pub fn resume_key(&self) -> Option<&SessionResumeKey>

Returns the session resume key, if the session is resumable.

pub fn shutdown(&self) -> Result<(), SessionError>

Request shutdown of the entire session (root + all virtual connections).

Trait Implementations

impl Clone for SessionHandle

fn clone(&self) -> SessionHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.