jsonrpsee_core::client::async_client

Struct PingConfig

source
pub struct PingConfig { /* private fields */ }
Available on crate features async-client and async-wasm-client and client only.
Expand description

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§

source§

impl PingConfig

source

pub fn new() -> Self

Create a new PingConfig.

source

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

Configure the interval when the WebSocket pings are sent out.

source

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 inresponsive.

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

source

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

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

§Panics

This method panics if max == 0.

Trait Implementations§

source§

impl Clone for PingConfig

source§

fn clone(&self) -> PingConfig

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for PingConfig

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for PingConfig

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Copy for PingConfig

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> MaybeSend for T
where T: Send,