Struct quinn_proto::EndpointConfig

pub struct EndpointConfig { /* private fields */ }

Global configuration for the endpoint, affecting all connections

Default values should be suitable for most internet applications.

Implementations

impl EndpointConfig

pub fn new(reset_key: Arc<dyn 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, key: Arc<dyn HmacKey>) -> &mut Self

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>) -> &mut Self

Override supported QUIC versions

pub fn grease_quic_bit(&mut self, value: bool) -> &mut Self

Whether to accept QUIC packets containing any value for the fixed bit

Enabled by default. Helps protect against protocol ossification and makes traffic less identifiable to observers. Disable if helping observers identify this traffic as QUIC is desired.

Trait Implementations

impl Clone for EndpointConfig

fn clone(&self) -> EndpointConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EndpointConfig

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

Formats the value using the given formatter.

impl Default for EndpointConfig

fn default() -> Self

Returns the “default value” for a type.