Trait s2n_quic_transport::endpoint::Endpoint

pub trait Endpoint: 'static + Send {
    type PathHandle: Handle;
    type Subscriber: Subscriber;

    const ENDPOINT_TYPE: Type;

    fn receive<Rx, C>(&mut self, rx: &mut Rx, clock: &C)
    where
        Rx: Queue<Handle = Self::PathHandle>,
        C: Clock;
    fn transmit<Tx, C>(&mut self, tx: &mut Tx, clock: &C)
    where
        Tx: Queue<Handle = Self::PathHandle>,
        C: Clock;
    fn poll_wakeups<C>(
        &mut self, 
        cx: &mut Context<'_>, 
        clock: &C
    ) -> Poll<Result<usize, CloseError>>
    where
        C: Clock;
    fn timeout(&self) -> Option<Timestamp>;
    fn set_max_mtu(&mut self, max_mtu: MaxMtu);
    fn subscriber(&mut self) -> &mut Self::Subscriber;

    fn wakeups<C>(&'a mut self, clock: &'a C) -> Wakeups<'a, Self, C>
    where
        C: Clock,
    { ... }
}

The main interface for a QUIC endpoint

Associated Types

type PathHandle: Handle

type Subscriber: Subscriber

Associated Constants

const ENDPOINT_TYPE: Type

Required methods

fn receive<Rx, C>(&mut self, rx: &mut Rx, clock: &C) where
    Rx: Queue<Handle = Self::PathHandle>,
    C: Clock, 

Receives and processes datagrams for the Rx queue

fn transmit<Tx, C>(&mut self, tx: &mut Tx, clock: &C) where
    Tx: Queue<Handle = Self::PathHandle>,
    C: Clock, 

Transmits outgoing datagrams into the Tx queue

fn poll_wakeups<C>(
    &mut self,
    cx: &mut Context<'_>,
    clock: &C
) -> Poll<Result<usize, CloseError>> where
    C: Clock, 

Polls for any application-space wakeups

When successful, the number of wakeups is returned.

fn timeout(&self) -> Option<Timestamp>

Returns the latest Timestamp at which transmit should be called

fn set_max_mtu(&mut self, max_mtu: MaxMtu)

Sets the largest maximum transmission unit (MTU) that can be sent on a path

fn subscriber(&mut self) -> &mut Self::Subscriber

Returns the endpoint’s event subscriber

Provided methods

fn wakeups<C>(&'a mut self, clock: &'a C) -> Wakeups<'a, Self, C> where
    C: Clock, 

Returns a future which polls for application-space wakeups

When successful, the number of wakeups is returned.

Implementors

impl<Cfg: Config> Endpoint for Endpoint<Cfg>

type PathHandle = Cfg::PathHandle

type Subscriber = Cfg::EventSubscriber

const ENDPOINT_TYPE: Type