Struct distant_core::Transport

pub struct Transport<T> where
    T: DataStream,  { /* fields omitted */ }

Represents a transport of data across the network

Implementations

impl Transport<InmemoryStream>

pub fn pair(
    buffer: usize
) -> (Transport<InmemoryStream>, Transport<InmemoryStream>)

Produces a pair of inmemory transports that are connected to each other with matching auth and encryption keys

Sets the buffer for message passing for each underlying stream to the given buffer size

impl Transport<TcpStream>

pub async fn connect(
    addrs: impl ToSocketAddrs,
    auth_key: Option<Arc<SecretKey>>
) -> Result<Self>

Establishes a connection using the provided session and performs a handshake to establish means of encryption, returning a transport ready to communicate with the other side

Takes an optional authentication key

pub fn peer_addr(&self) -> Result<SocketAddr>

Returns the address of the peer the transport is connected to

impl Transport<UnixStream>

pub async fn connect(
    path: impl AsRef<Path>,
    auth_key: Option<Arc<SecretKey>>
) -> Result<Self>

Establishes a connection using the provided session and performs a handshake to establish means of encryption, returning a transport ready to communicate with the other side

Takes an optional authentication key

pub fn peer_addr(&self) -> Result<SocketAddr>

Returns the address of the peer the transport is connected to

impl<T> Transport<T> where
    T: DataStream, 

pub fn new(
    stream: T,
    auth_key: Option<Arc<SecretKey>>,
    crypt_key: Arc<SecretKey>
) -> Self

Creates a new instance of the transport, wrapping the stream in a Framed<T, DistantCodec>

pub async fn from_handshake(
    stream: T,
    auth_key: Option<Arc<SecretKey>>
) -> Result<Self>

Takes a pre-existing connection and performs a handshake to build out the encryption key with the remote system, returning a transport ready to communicate with the other side

An optional authentication key can be provided that will be used alongside encryption when communicating across the wire

pub async fn send<D: Serialize>(
    &mut self,
    data: D
) -> Result<(), TransportError>

Sends some data across the wire, waiting for it to completely send

pub async fn receive<R: DeserializeOwned>(
    &mut self
) -> Result<Option<R>, TransportError>

Receives some data from out on the wire, waiting until it’s available, returning none if the transport is now closed

pub fn to_connection_tag(&self) -> String

Returns a textual description of the transport’s underlying connection

pub fn into_split(
    self
) -> (TransportReadHalf<T::Read>, TransportWriteHalf<T::Write>)

Splits transport into read and write halves

Trait Implementations

impl<T: Debug> Debug for Transport<T> where
    T: DataStream, 

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

Formats the value using the given formatter.