Struct s2n_quic::client::Client

pub struct Client { /* private fields */ }

A QUIC client endpoint, capable of opening connections

Implementations

impl Client

pub fn bind<T>(socket: T) -> Result<Self, StartError>where
    T: TryInto,

Starts listening on the provided socket

Examples

let Client = Client::bind("0.0.0.0:0")?;

pub fn builder() -> Builder<impl ClientProviders>

Returns a Builder which is able to configure the Client components.

Examples

use std::path::Path;
use s2n_quic::Client;

let client = Client::builder()
    .with_tls(Path::new("./certs/cert.pem"))?
    .with_io("0.0.0.0:0")?
    .start()?;

pub fn connect(&self, connect: Connect) -> ConnectionAttempt

Establishes a connection to the specified endpoint

Examples

use s2n_quic::Client;
use std::{net::SocketAddr, path::Path};

let client = Client::builder()
    .with_tls(Path::new("./certs/cert.pem"))?
    .with_io("0.0.0.0:0")?
    .start()?;

let addr: SocketAddr = "127.0.0.1:443".parse()?;
let connection = client.connect(addr.into()).await?;

pub async fn wait_idle(&mut self) -> Result<(), Error>

Wait for the client endpoint to finish handling all outstanding connections

Notifies the endpoint of application interest in closing the endpoint. The call waits for all outstanding connections to finish before returning.

Note: The endpoint will continue to accept new connection attempts. If there are other client handles with active connections, then this call will never return.

Examples

use s2n_quic::Client;
use std::{net::SocketAddr, path::Path};

let mut client = Client::builder()
    .with_tls(Path::new("./certs/cert.pem"))?
    .with_io("0.0.0.0:0")?
    .start()?;

let addr: SocketAddr = "127.0.0.1:443".parse()?;
let connection = client.connect(addr.into()).await?;

client.wait_idle().await?;

pub fn local_addr(&self) -> Result<SocketAddr, Error>

Returns the local address that this listener is bound to.

This can be useful, for example, when binding to port 0 to figure out which port was actually bound.

Examples

let client = Client::bind("0.0.0.0:0")?;

let local_addr = client.local_addr()?;
assert_ne!(local_addr.port(), 0);

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.