Struct Endpoint

pub struct Endpoint {
    pub default_client_config: Option<ClientConfig>,
    /* private fields */
}

A QUIC endpoint.

Fields

default_client_config: Option<ClientConfig>

The client configuration used by connect

Implementations

impl Endpoint

pub fn new( socket: UdpSocket, config: EndpointConfig, server_config: Option<ServerConfig>, default_client_config: Option<ClientConfig>, ) -> Result<Self>

Create a QUIC endpoint.

pub async fn client(addr: impl ToSocketAddrsAsync) -> Result<Endpoint>

Available on rustls only.

Helper to construct an endpoint for use with outgoing connections only.

Note that addr is the local address to bind to, which should usually be a wildcard address like 0.0.0.0:0 or [::]:0, which allow communication with any reachable IPv4 or IPv6 address respectively from an OS-assigned port.

If an IPv6 address is provided, the socket may dual-stack depending on the platform, so as to allow communication with both IPv4 and IPv6 addresses. As such, calling this method with the address [::]:0 is a reasonable default to maximize the ability to connect to other address.

IPv4 client is never dual-stack.

pub async fn server( addr: impl ToSocketAddrsAsync, config: ServerConfig, ) -> Result<Self>

Available on rustls only.

Helper to construct an endpoint for use with both incoming and outgoing connections

Platform defaults for dual-stack sockets vary. For example, any socket bound to a wildcard IPv6 address on Windows will not by default be able to communicate with IPv4 addresses. Portable applications should bind an address that matches the family they wish to communicate within.

pub fn connect( &self, remote: SocketAddr, server_name: &str, config: Option<ClientConfig>, ) -> Result<Connecting, ConnectError>

Connect to a remote endpoint.

pub async fn wait_incoming(&self) -> Option<Incoming>

Wait for the next incoming connection attempt from a client.

Yields Incomings, or None if the endpoint is closed. Incoming can be awaited to obtain the final Connection, or used to e.g. filter connection attempts or force address validation, or converted into an intermediate Connecting future which can be used to e.g. send 0.5-RTT data.

pub fn set_server_config(&self, server_config: Option<ServerConfig>)

Replace the server configuration, affecting new incoming connections only.

Useful for e.g. refreshing TLS certificates without disrupting existing connections.

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

Get the local SocketAddr the underlying socket is bound to.

pub fn open_connections(&self) -> usize

Get the number of connections that are currently open.

pub fn close(&self, error_code: VarInt, reason: &[u8])

Close all of this endpoint’s connections immediately and cease accepting new connections.

See Connection::close() for details.

pub async fn shutdown(self) -> Result<()>

Gracefully shutdown the endpoint.

Wait for all connections on the endpoint to be cleanly shut down and close the underlying socket. This will wait for all clones of the endpoint, all connections and all streams to be dropped before closing the socket.

Waiting for this condition before exiting ensures that a good-faith effort is made to notify peers of recent connection closes, whereas exiting immediately could force them to wait out the idle timeout period.

Does not proactively close existing connections. Consider calling close() if that is desired.

Trait Implementations

impl Clone for Endpoint

fn clone(&self) -> Endpoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Endpoint

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

Formats the value using the given formatter.

impl Drop for Endpoint

fn drop(&mut self)

Executes the destructor for this type.