Struct EngineIoConfig 

pub struct EngineIoConfig {
    pub req_path: Cow<'static, str>,
    pub ping_interval: Duration,
    pub ping_timeout: Duration,
    pub max_buffer_size: usize,
    pub max_payload: u64,
    pub ws_read_buffer_size: usize,
    pub transports: u8,
}

Configuration for the engine.io engine & transports

Fields

req_path: Cow<'static, str>

The path to listen for engine.io requests on. Defaults to “/engine.io”.

ping_interval: Duration

The interval at which the server will send a ping packet to the client. Defaults to 25 seconds.

ping_timeout: Duration

The amount of time the server will wait for a ping response from the client before closing the connection. Defaults to 20 seconds.

max_buffer_size: usize

The maximum number of packets that can be buffered per connection before being emitted to the client.

If the buffer if full the emit() method will return an error

Defaults to 128 packets

max_payload: u64

The maximum number of bytes that can be received per http request. Defaults to 100KB.

ws_read_buffer_size: usize

The size of the read buffer for the websocket transport. You can tweak this value depending on your use case. By default it is set to 4KiB.

Setting it to a higher value will improve performance on heavy read scenarios but will consume more memory.

transports: u8

Allowed transports on this server It is represented as a bitfield to allow to combine any number of transports easily

Implementations

impl EngineIoConfig

pub fn builder() -> EngineIoConfigBuilder

Create a new builder with a default config

pub fn allowed_transport(&self, transport: TransportType) -> bool

Check if a TransportType is enabled in the EngineIoConfig

Trait Implementations

impl Clone for EngineIoConfig

fn clone(&self) -> EngineIoConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EngineIoConfig

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

Formats the value using the given formatter.

impl Default for EngineIoConfig

fn default() -> Self

Returns the “default value” for a type.