Struct distant_core::Session

pub struct Session { /* fields omitted */ }

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

Implementations

impl Session

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

Connect to a remote TCP server using the provided information

pub async fn tcp_connect_timeout<U>(
    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

impl Session

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

Connect to a proxy unix socket

pub async fn unix_connect_timeout<U>(
    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

impl Session

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

impl Session

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)

pub fn abort(&self)

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

pub fn clone_channel(&self) -> SessionChannel

Clones the underlying channel for requests and returns the cloned instance

Methods from Deref<Target = SessionChannel>

pub fn is_closed(&self) -> bool

Returns true if no more requests can be transferred

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

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

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

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

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

Sends a request without waiting for a response, timing out after duration has passed

Trait Implementations

impl Deref for Session

type Target = SessionChannel

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Session

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<Session> for SessionChannel

fn from(session: Session) -> Self

Performs the conversion.