pub struct Endpoint { /* private fields */ }Expand description
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.
Implementations§
source§impl Endpoint
impl Endpoint
sourcepub fn client(addr: SocketAddr) -> Result<Self>
pub fn client(addr: SocketAddr) -> Result<Self>
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.
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.
sourcepub fn server(config: ServerConfig, addr: SocketAddr) -> Result<Self>
pub fn server(config: ServerConfig, addr: SocketAddr) -> Result<Self>
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.
sourcepub fn new(
config: EndpointConfig,
server_config: Option<ServerConfig>,
socket: UdpSocket,
runtime: impl Runtime
) -> Result<Self>
pub fn new(
config: EndpointConfig,
server_config: Option<ServerConfig>,
socket: UdpSocket,
runtime: impl Runtime
) -> Result<Self>
Construct an endpoint with arbitrary configuration and socket
sourcepub fn new_with_abstract_socket(
config: EndpointConfig,
server_config: Option<ServerConfig>,
socket: impl AsyncUdpSocket,
runtime: impl Runtime
) -> Result<Self>
pub fn new_with_abstract_socket(
config: EndpointConfig,
server_config: Option<ServerConfig>,
socket: impl AsyncUdpSocket,
runtime: impl Runtime
) -> Result<Self>
Construct an endpoint with arbitrary configuration and pre-constructed abstract socket
Useful when socket has additional state (e.g. sidechannels) attached for which shared
ownership is needed.
sourcepub fn accept(&self) -> Accept<'_> ⓘ
pub fn accept(&self) -> Accept<'_> ⓘ
Get the next incoming connection attempt from a client
Yields Connecting futures that must be awaited to obtain the final Connection, or
None if the endpoint is closed.
sourcepub fn set_default_client_config(&mut self, config: ClientConfig)
pub fn set_default_client_config(&mut self, config: ClientConfig)
Set the client configuration used by connect
sourcepub fn connect(
&self,
addr: SocketAddr,
server_name: &str
) -> Result<Connecting, ConnectError>
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.
sourcepub fn connect_with(
&self,
config: ClientConfig,
addr: SocketAddr,
server_name: &str
) -> Result<Connecting, ConnectError>
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.
sourcepub fn rebind(&self, socket: UdpSocket) -> Result<()>
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.
sourcepub fn set_server_config(&self, server_config: Option<ServerConfig>)
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.
sourcepub fn local_addr(&self) -> Result<SocketAddr>
pub fn local_addr(&self) -> Result<SocketAddr>
Get the local SocketAddr the underlying socket is bound to
sourcepub fn close(&self, error_code: VarInt, reason: &[u8])
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.
sourcepub async fn wait_idle(&self)
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.