Struct tk_http::websocket::Config

pub struct Config { /* fields omitted */ }

Configuration of a websocket::Loop object (a server-side websocket connection).

Methods

impl Config

pub fn new() -> Config

Create a config with defaults

pub fn ping_interval(&mut self, dur: Duration) -> &mut Self

Set ping interval

Default is 10 seconds.

If no messages have been received within this interval, we send a ping message. Only full messages are accounted. If some large frame is being received for this long, we still send ping.

Note: you can't remove the interval, but you can set it to a sufficiently large value.

Note 2: you may also need to tune inactivity timeout if you change this value.

pub fn message_timeout(&mut self, dur: Duration) -> &mut Self

Set inactivity timeout

Default is 25 seconds.

A connection is shut down if no messages were received during this interval.

Note: only full frames are accounted. If some very large frame is being sent too long, we drop the connection. So be sure to set this value large enough so that slowest client can send largest frame and another ping.

There are two use cases for this interval:

1. Make it 2.5x the ping_interval to detect connections which don't have destination host alive

2. Inactivity interval that is smaller than ping_interval will detect connections which are alive but do not send any messages. This is similar to how HTTP servers shutdown inactive connections.

Note: you may also need to tune ping interval if you change this value.

pub fn inactivity_timeout(&mut self, dur: Duration) -> &mut Self

Sets both message timeout and byte timeout to the same value

pub fn byte_timeout(&mut self, dur: Duration) -> &mut Self

Similar to message timeout but works at byte level

Being less strict timeout this value is two-way: any byte sent or received resets the timer (Also, we do our best to ignore outgoing pings)

There are two points to consider for tweaking timeout:

1. To prevent resource exhaustion by a peer: sending a byte at a time, you might make it higher, up to message timeout
2. To be able to receive larger messages (say 1Mb or 10 Mb) you can make message timeout much larger for largest message to fit, but make byte timeout smaller so that if nothing it being received you can close connection earlier.

Note: there is no sense to make this value larger than message_timeout

pub fn max_packet_size(&mut self, size: usize) -> &mut Self

Maximum packet size

If some frame declares size larger than this, we immediately abort the connection

pub fn done(&mut self) -> Arc<Config>

Create a Arc'd config clone to pass to the constructor

This is just a convenience method.

Trait Implementations

impl Debug for Config

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.