Struct RedisAdapterConfig

pub struct RedisAdapterConfig {
    pub request_timeout: Duration,
    pub prefix: Cow<'static, str>,
    pub ack_response_buffer: usize,
    pub stream_buffer: usize,
}

The configuration of the RedisAdapter.

Fields

request_timeout: Duration

The request timeout. It is mainly used when expecting response such as when using broadcast_with_ack or rooms. Default is 5 seconds.

prefix: Cow<'static, str>

The prefix used for the channels. Default is “socket.io”.

ack_response_buffer: usize

The channel size used to receive ack responses. Default is 255.

If you have a lot of servers/sockets and that you may miss acknowledgement because they arrive faster than you poll them with the returned stream, you might want to increase this value.

stream_buffer: usize

The channel size used to receive messages. Default is 1024.

If your server is under heavy load, you might want to increase this value.

Implementations

impl RedisAdapterConfig

pub fn new() -> Self

Create a new config.

pub fn with_request_timeout(self, timeout: Duration) -> Self

Set the request timeout. Default is 5 seconds.

pub fn with_prefix(self, prefix: impl Into<Cow<'static, str>>) -> Self

Set the prefix used for the channels. Default is “socket.io”.

pub fn with_ack_response_buffer(self, buffer: usize) -> Self

Set the channel size used to send ack responses. Default is 255.

If you have a lot of servers/sockets and that you may miss acknowledgement because they arrive faster than you poll them with the returned stream, you might want to increase this value.

pub fn with_stream_buffer(self, buffer: usize) -> Self

Set the channel size used to receive messages. Default is 1024.

If your server is under heavy load, you might want to increase this value.

Trait Implementations

impl Clone for RedisAdapterConfig

fn clone(&self) -> RedisAdapterConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RedisAdapterConfig

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

Formats the value using the given formatter.

impl Default for RedisAdapterConfig

fn default() -> Self

Returns the “default value” for a type.