Struct quinn_proto::Endpoint

pub struct Endpoint { /* private fields */ }

The main entry point to the library

This object performs no I/O whatsoever. Instead, it generates a stream of packets to send via poll_transmit, and consumes incoming packets and connection-generated events via handle and handle_event.

Implementations

impl Endpoint

pub fn new( config: Arc<EndpointConfig>, server_config: Option<Arc<ServerConfig>>, allow_mtud: bool ) -> Self

Create a new endpoint

allow_mtud enables path MTU detection when requested by Connection configuration for better performance. This requires that outgoing packets are never fragmented, which can be achieved via e.g. the IPV6_DONTFRAG socket option.

pub fn poll_transmit(&mut self) -> Option<Transmit>

Get the next packet to transmit

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

Replace the server configuration, affecting new incoming connections only

pub fn handle_event( &mut self, ch: ConnectionHandle, event: EndpointEvent ) -> Option<ConnectionEvent>

Process EndpointEvents emitted from related Connections

In turn, processing this event may return a ConnectionEvent for the same Connection.

pub fn handle( &mut self, now: Instant, remote: SocketAddr, local_ip: Option<IpAddr>, ecn: Option<EcnCodepoint>, data: BytesMut ) -> Option<(ConnectionHandle, DatagramEvent)>

Process an incoming UDP datagram

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

Initiate a connection

pub fn set_socket_buffer_fill(&mut self, len: usize)

Set the socket_buffer_fill to the input len

pub fn reject_new_connections(&mut self)

Reject new incoming connections without affecting existing connections

Convenience short-hand for using set_server_config to update concurrent_connections to zero.

pub fn config(&self) -> &EndpointConfig

Access the configuration used by this endpoint

Trait Implementations

impl Debug for Endpoint

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

Formats the value using the given formatter.