Struct quinn_proto::generic::EndpointConfig

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

Global configuration for the endpoint, affecting all connections

Default values should be suitable for most internet applications.

Implementations

impl<S> EndpointConfig<S> where
    S: Session, 

pub fn new(reset_key: S::HmacKey) -> Self

Create a default config with a particular reset_key

pub fn cid_generator<F: Fn() -> Box<dyn ConnectionIdGenerator> + Send + Sync + 'static>(
    &mut self,
    factory: F
) -> &mut Self

Supply a custom connection ID generator factory

Called once by each Endpoint constructed from this configuration to obtain the CID generator which will be used to generate the CIDs used for incoming packets on all connections involving that Endpoint. A custom CID generator allows applications to embed information in local connection IDs, e.g. to support stateless packet-level load balancers.

EndpointConfig::new() applies a default random CID generator factory. This functions accepts any customized CID generator to reset CID generator factory that implements the ConnectionIdGenerator trait.

pub fn reset_key(&mut self, value: &[u8]) -> Result<&mut Self, ConfigError>

Private key used to send authenticated connection resets to peers who were communicating with a previous instance of this endpoint.

pub fn max_udp_payload_size(
    &mut self,
    value: u64
) -> Result<&mut Self, ConfigError>

Maximum UDP payload size accepted from peers. Excludes UDP and IP overhead.

The default is suitable for typical internet applications. Applications which expect to run on networks supporting Ethernet jumbo frames or similar should set this appropriately.

pub fn supported_versions(
    &mut self,
    supported_versions: Vec<u32>,
    initial_version: u32
) -> Result<&mut Self, ConfigError>

Override supported QUIC versions

Trait Implementations

impl<S: Session> Clone for EndpointConfig<S>

fn clone(&self) -> Self

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: Session> Debug for EndpointConfig<S>

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

Formats the value using the given formatter.

impl<S: Session> Default for EndpointConfig<S>

fn default() -> Self

Returns the “default value” for a type.