Struct jsonrpsee_ws_client::client::WsClientBuilder

pub struct WsClientBuilder<'a> { /* fields omitted */ }

Configuration.

Implementations

impl<'a> WsClientBuilder<'a>

pub fn max_request_body_size(self, size: usize) -> Self

Set max request body size.

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

Set request timeout.

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

Set connection timeout for the handshake.

pub fn origin_header(self, origin: Option<Cow<'a, str>>) -> Self

Set origin header to pass during the handshake.

pub fn handshake_url(self, url: Cow<'a, str>) -> Self

Set URL to send during the handshake.

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

Set max concurrent requests.

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

Set max concurrent notification capacity for each subscription; when the capacity is exceeded the subscription will be dropped.

You can also prevent the subscription being dropped by calling WsSubscription::next() frequently enough such that the buffer capacity doesn’t exceeds.

Note: The actual capacity is num_senders + max_subscription_capacity because it is passed to [futures::channel::mpsc::channel].

pub async fn build(self, url: &'a str) -> Result<WsClient, Error>

Build the client with specified URL to connect to. If the port number is missing from the URL, the default port number is used.

ws://host - port 80 is used

wss://host - port 443 is used

Trait Implementations

impl<'a> Clone for WsClientBuilder<'a>

fn clone(&self) -> WsClientBuilder<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for WsClientBuilder<'a>

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

Formats the value using the given formatter.

impl<'a> Default for WsClientBuilder<'a>

fn default() -> Self

Returns the “default value” for a type.