Struct distant_core::Session

source · [−]

pub struct Session { /* private fields */ }

Expand description

Represents a session with a remote server that can be used to send requests & receive responses

Implementations

source

impl Session

source

pub async fn tcp_connect(addr: SocketAddr, codec: U) -> Result<Self> where
U: Codec + Send + 'static,

Connect to a remote TCP server using the provided information

source

pub async fn tcp_connect_timeout(
 addr: SocketAddr,
 codec: U,
 duration: Duration
) -> Result<Self> where
 U: Codec + Send + 'static,

Connect to a remote TCP server, timing out after duration has passed

source

pub fn into_channel(self) -> SessionChannel

Convert into underlying channel

source

impl Session

source

pub async fn unix_connect(path: impl AsRef<Path>, codec: U) -> Result<Self> where
U: Codec + Send + 'static,

Connect to a proxy unix socket

source

pub async fn unix_connect_timeout(
 path: impl AsRef<Path>,
 codec: U,
 duration: Duration
) -> Result<Self> where
 U: Codec + Send + 'static,

Connect to a proxy unix socket, timing out after duration has passed

source

impl Session

source

pub fn initialize<T, U>(transport: Transport<T, U>) -> Result<Self> where
T: DataStream,
U: Codec + Send + 'static,

Initializes a session using the provided transport and no extra details

source

pub fn initialize_with_details<T, U>(
 transport: Transport<T, U>,
 details: Option<SessionDetails>
) -> Result<Self> where
 T: DataStream,
 U: Codec + Send + 'static,

Initializes a session using the provided transport and extra details

source

impl Session

source

pub fn details(&self) -> Option<&SessionDetails>

Returns details about the session, if it has any

source

pub async fn wait(self) -> Result<(), JoinError>

Waits for the session to terminate, which results when the receiving end of the network connection is closed (or the session is shutdown)

source

pub fn abort(&self)

Abort the session’s current connection by forcing its response task to shutdown

source

pub fn clone_channel(&self) -> SessionChannel

Clones the underlying channel for requests and returns the cloned instance

Methods from Deref<Target = SessionChannel>

source

pub fn is_closed(&self) -> bool

Returns true if no more requests can be transferred

source

pub async fn mail(&mut self, req: Request) -> Result<Mailbox, TransportError>

Sends a request and returns a mailbox that can receive one or more responses, failing if unable to send a request or if the session’s receiving line to the remote server has already been severed

source

pub async fn send(&mut self, req: Request) -> Result<Response, TransportError>

Sends a request and waits for a response, failing if unable to send a request or if the session’s receiving line to the remote server has already been severed

source

pub async fn send_timeout(
 &mut self,
 req: Request,
 duration: Duration
) -> Result<Response, TransportError>

Sends a request and waits for a response, timing out after duration has passed

source

pub async fn fire(&mut self, req: Request) -> Result<(), TransportError>

Sends a request without waiting for a response; this method is able to be used even if the session’s receiving line to the remote server has been severed

source