Struct EndpointOwner 

pub struct EndpointOwner(pub EndpointGuard);

HTTP/3 uses H3_NO_ERROR (0x100), unlike raw QUIC/DoQ’s application zero. Close first so the shared transport guards’ subsequent Drop is harmless.

Tuple Fields

0: EndpointGuard

Methods from Deref<Target = Endpoint>

pub fn stats(&self) -> EndpointStats

Returns relevant stats from this Endpoint

pub fn accept(&self) -> Accept<'_>

Get 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 connect( &self, addr: SocketAddr, server_name: &str, ) -> Result<Connecting, ConnectError>

Connect to a remote endpoint

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<(), Error>

Switch to a new UDP socket

See Endpoint::rebind_abstract() for details.

pub fn rebind_abstract( &self, socket: Arc<dyn AsyncUdpSocket>, ) -> Result<(), Error>

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 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, Error>

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 wait_idle(&self)

Wait for all connections on the endpoint to be cleanly shut down

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 or cause incoming connections to be rejected. Consider calling close() if that is desired.

Trait Implementations

impl Deref for EndpointOwner

type Target = Endpoint

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Drop for EndpointOwner

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.