Struct PingConfig

pub struct PingConfig { /* private fields */ }

Configuration for WebSocket ping/pong mechanism and it may be used to disconnect an inactive connection.

jsonrpsee doesn’t associate the ping/pong frames just that if a pong frame isn’t received within the inactive_limit then it’s regarded as missed.

Such that the inactive_limit should be configured to longer than a single WebSocket ping takes or it might be missed and may end up terminating the connection.

Default: ping_interval: 30 seconds, max failures: 1 and inactive limit: 40 seconds.

Implementations

impl PingConfig

pub fn new() -> Self

Create a new PingConfig.

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

Configure the interval when the WebSocket pings are sent out.

pub fn inactive_limit(self, inactivity_limit: Duration) -> Self

Configure how long to wait for the WebSocket pong. When this limit is expired it’s regarded as the client is unresponsive.

You may configure how many times the client is allowed to be “inactive” by PingConfig::max_failures.

pub fn max_failures(self, max: usize) -> Self

Configure how many times the remote peer is allowed be inactive until the connection is closed.

Panics

This method panics if max == 0.

Trait Implementations

impl Clone for PingConfig

fn clone(&self) -> PingConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PingConfig

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

Formats the value using the given formatter.

impl Default for PingConfig

fn default() -> Self

Returns the “default value” for a type.

impl Copy for PingConfig