Struct quinn::Endpoint

pub struct Endpoint { /* fields omitted */ }

A QUIC endpoint.

An endpoint corresponds to a single UDP socket, may host many connections, and may act as both client and server for different connections.

May be cloned to obtain another handle to the same endpoint.

Methods

impl Endpoint

pub fn builder() -> EndpointBuilder

Begin constructing an Endpoint

pub fn connect(
    &self,
    addr: &SocketAddr,
    server_name: &str
) -> Result<Connecting, ConnectError>

Connect to a remote endpoint. Be sure to spawn the ConnectionDriver after connecting.

server_name must be covered by the certificate presented by the server. This prevents a connection from being intercepted by an attacker with a valid certificate for some other server.

May fail immediately due to configuration errors, or in the future if the connection could not be established.

pub fn connect_with(
    &self,
    config: ClientConfig,
    addr: &SocketAddr,
    server_name: &str
) -> Result<Connecting, ConnectError>

Connect to a remote endpoint using a custom configuration.

See connect for details.

pub fn rebind(&self, socket: UdpSocket) -> Result<()>

Switch to a new UDP socket

Allows the endpoint's address to be updated live, affecting all active connections. Incoming connections and connections to servers unreachable from the new address will be lost.

On error, the old UDP socket is retained.

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

Get the local SocketAddr the underlying socket is bound to

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.

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.