Struct jsonrpsee_core::client::async_client::ClientBuilder

pub struct ClientBuilder { /* private fields */ }

Available on crate features async-client and async-wasm-client and client only.

Builder for Client.

Implementations

impl ClientBuilder

pub fn new() -> ClientBuilder

Create a builder for the client.

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

Set request timeout (default is 60 seconds).

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

Set max concurrent requests (default is 256).

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

Set max buffer capacity for each subscription; when the capacity is exceeded the subscription will be dropped (default is 1024).

You may prevent the subscription from being dropped by polling often enough Subscription::next() such that it can keep with the rate as server produces new items on the subscription.

Panics

This function panics if max is 0.

pub fn id_format(self, id_kind: IdKind) -> Self

Configure the data type of the request object ID (default is number).

pub fn set_max_logging_length(self, max: u32) -> Self

Set maximum length for logging calls and responses.

Logs bigger than this limit will be truncated.

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

Set the interval at which pings frames are submitted (disabled by default).

Periodically submitting pings at a defined interval has mainly two benefits:

• Directly, it acts as a “keep-alive” alternative in the WebSocket world.
• Indirectly by inspecting debug logs, it ensures that the endpoint is still responding to messages.

The underlying implementation does not make any assumptions about at which intervals pongs are received.

Note: The interval duration is restarted when

• a frontend command is submitted
• a reply is received from the backend
• the interval duration expires

pub fn build_with_tokio<S, R>(self, sender: S, receiver: R) -> Client

where S: TransportSenderT + Send, R: TransportReceiverT + Send,

Build the client with given transport.

Panics

Panics if called outside of tokio runtime context.

Trait Implementations

impl Clone for ClientBuilder

fn clone(&self) -> ClientBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientBuilder

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

Formats the value using the given formatter.

impl Default for ClientBuilder

fn default() -> Self

Returns the “default value” for a type.

impl Copy for ClientBuilder