Struct tokio_xmpp::xmlstream::Timeouts

pub struct Timeouts {
    pub read_timeout: Duration,
    pub response_timeout: Duration,
}

Configuration for timeouts on an XML stream.

The defaults are tuned toward common desktop/laptop use and may not hold up to extreme conditions (arctic satellite link, mobile internet on a train in Brandenburg, Germany, and similar) and may be inefficient in other conditions (stable server link, localhost communication).

Fields

read_timeout: Duration

Maximum silence time before a ReadError::SoftTimeout is returned.

Soft timeouts are not fatal, but they must be handled by user code so that more data is read after at most Self::response_timeout, starting from the moment the soft timeout is returned.

response_timeout: Duration

Maximum silence after a soft timeout.

If the stream is silent for longer than this time after a soft timeout has been emitted, a hard TimedOut I/O error is returned and the stream is to be considered dead.

Implementations

impl Timeouts

pub fn tight() -> Self

Tight timeouts suitable for communicating on a fast LAN or localhost.

Trait Implementations

impl Clone for Timeouts

fn clone(&self) -> Timeouts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Timeouts

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

Formats the value using the given formatter.

impl Default for Timeouts

fn default() -> Self

Returns the “default value” for a type.

impl Copy for Timeouts