Struct Connection

pub struct Connection<P> { /* private fields */ }

A connection to a server

Implementations

impl<P> Connection<P>

pub fn new<S>( byte_stream: S, cfg: Config, recon_strat: Option<ReconStrat<S>>, ) -> Self

where S: ByteStream, P: Packet<PlainBytes> + Send + 'static, P::Header: Send,

Creates a new connection to a server with an existing stream

pub fn new_encrypted<S>( byte_stream: S, cfg: Config, recon_strat: Option<ReconStrat<S>>, sign: PublicKey, ) -> Self

where S: ByteStream, P: Packet<EncryptedBytes> + Send + 'static, P::Header: Send,

Available on crate feature encrypted only.

Creates a new connection to a server and encrypting all packets sent

pub fn update_config(&self, cfg: Config)

Update the connection configuration

pub fn configurator(&self) -> Configurator<Config>

Get’s a Configurator which allows to configure this connection without needing to have access to the connection

pub async fn request(&self, packet: P) -> Result<P, RequestError>

Send a request waiting until a response is available or the connection closes

Errors

• Writing the packet failed
• Reading the response packet failed
• Io Error

pub async fn request_sender( &self, packet: P, ) -> Result<StreamSender<P>, RequestError>

Create a new stream to send packets.

pub async fn request_receiver( &self, packet: P, ) -> Result<StreamReceiver<P>, RequestError>

Opens a new stream to listen to packets.

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

Wait until the connection has nothing more todo which will then close the connection.

pub async fn close(self) -> Result<(), TaskError>

Send a close signal to the background task and wait until it closes.