Struct quinn_proto::generic::Endpoint

pub struct Endpoint<S> where
    S: Session,  { /* fields omitted */ }

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<S> Endpoint<S> where
    S: Session, 

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

Create a new endpoint

Returns Err if the configuration is invalid.

#[must_use]

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

Get the next packet to transmit

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<S>)>

Process an incoming UDP datagram

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

Initiate a connection

pub fn reject_new_connections(&mut self)

Unconditionally reject future incoming connections

pub fn config(&self) -> &EndpointConfig<S>

Access the configuration used by this endpoint

Trait Implementations

impl<S> Debug for Endpoint<S> where
    S: Session, 

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

Formats the value using the given formatter.