Struct quinn::generic::EndpointBuilder

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

A helper for constructing an Endpoint.

See ClientConfigBuilder for details on trust defaults.

Implementations

impl<S> EndpointBuilder<S> where
    S: Session + Send + 'static, 

pub fn new(
    config: EndpointConfig<S>,
    default_client_config: ClientConfig<S>
) -> Self

Start a builder with a specific initial low-level configuration.

pub fn bind(
    self,
    addr: &SocketAddr
) -> Result<(Endpoint<S>, Incoming<S>), EndpointError>

Build an endpoint bound to addr

Must be called from within a tokio runtime context. To avoid consuming the EndpointBuilder, call clone() first.

Platform defaults for dual-stack sockets vary. For example, any socket bound to a wildcard IPv6 address on Windows will not by default be able to communicate with IPv4 addresses. Portable applications should bind an address that matches the family they wish to communicate within.

pub fn with_socket(
    self,
    socket: UdpSocket
) -> Result<(Endpoint<S>, Incoming<S>), EndpointError>

Build an endpoint around a pre-configured socket

Must be called from within a tokio runtime context. To avoid consuming the EndpointBuilder, call clone() first.

pub fn listen(&mut self, config: ServerConfig<S>) -> &mut Self

Accept incoming connections.

pub fn default_client_config(&mut self, config: ClientConfig<S>) -> &mut Self

Set the default configuration used for outgoing connections.

The default can be overriden by using Endpoint::connect_with().

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

Use a customized cid generator factory in the endpoint

Trait Implementations

impl<S: Clone> Clone for EndpointBuilder<S> where
    S: Session, 

fn clone(&self) -> EndpointBuilder<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<S> Default for EndpointBuilder<S> where
    S: Session, 

fn default() -> Self

Returns the “default value” for a type.