Struct substrate_rpc_client::WsClientBuilder

pub struct WsClientBuilder { /* private fields */ }

Builder for WsClient.

Examples

use jsonrpsee_ws_client::{WsClientBuilder, HeaderMap, HeaderValue};

#[tokio::main]
async fn main() {
    // Build custom headers used during the handshake process.
    let mut headers = HeaderMap::new();
    headers.insert("Any-Header-You-Like", HeaderValue::from_static("42"));

    // Build client
    let client = WsClientBuilder::default()
         .set_headers(headers)
         .build("wss://localhost:443")
         .await
         .unwrap();

    // use client....
}

Implementations

impl WsClientBuilder

pub fn new() -> WsClientBuilder

Create a new WebSocket client builder.

pub fn use_native_rustls(self) -> WsClientBuilder

Force to use the rustls native certificate store.

Since multiple certificate stores can be optionally enabled, this option will force the native certificate store to be used.

This is enabled with the default settings and features.

Optional

This requires the optional native-tls feature.

pub fn max_request_size(self, size: u32) -> WsClientBuilder

See documentation WsTransportClientBuilder::max_request_size (default is 10 MB).

pub fn max_response_size(self, size: u32) -> WsClientBuilder

See documentation WsTransportClientBuilder::max_response_size (default is 10 MB).

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

See documentation ClientBuilder::request_timeout (default is 60 seconds).

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

See documentation WsTransportClientBuilder::connection_timeout (default is 10 seconds).

pub fn enable_ws_ping(self, cfg: PingConfig) -> WsClientBuilder

See documentation ClientBuilder::enable_ws_ping (disabled by default).

pub fn disable_ws_ping(self) -> WsClientBuilder

See documentation ClientBuilder::disable_ws_ping

pub fn set_headers(self, headers: HeaderMap) -> WsClientBuilder

See documentation WsTransportClientBuilder::set_headers (default is none).

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

See documentation ClientBuilder::max_concurrent_requests (default is 256).

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

See documentation ClientBuilder::max_buffer_capacity_per_subscription (default is 1024).

pub fn max_redirections(self, redirect: usize) -> WsClientBuilder

See documentation WsTransportClientBuilder::max_redirections (default is 5).

pub fn id_format(self, kind: IdKind) -> WsClientBuilder

See documentation for ClientBuilder::id_format (default is Number).

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

Set maximum length for logging calls and responses.

Logs bigger than this limit will be truncated.

pub fn set_tcp_no_delay(self, no_delay: bool) -> WsClientBuilder

See documentation ClientBuilder::set_tcp_no_delay (default is true).

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

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

Build the WsClient with specified TransportSenderT TransportReceiverT parameters

Panics

Panics if being called outside of tokio runtime context.

pub async fn build_with_stream<T>( self, url: impl AsRef<str>, data_stream: T ) -> Result<Client, Error>

where T: AsyncRead + AsyncWrite + Unpin + MaybeSend + 'static,

Build the WsClient with specified data stream, using WsTransportClientBuilder::build_with_stream.

Panics

Panics if being called outside of tokio runtime context.

pub async fn build(self, url: impl AsRef<str>) -> Result<Client, Error>

Build the WsClient with specified URL to connect to, using the default WsTransportClientBuilder::build_with_stream, therefore with the default TCP as transport layer.

Panics

Panics if being called outside of tokio runtime context.

Trait Implementations

impl Clone for WsClientBuilder

fn clone(&self) -> WsClientBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WsClientBuilder

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

Formats the value using the given formatter.

impl Default for WsClientBuilder

fn default() -> WsClientBuilder

Returns the “default value” for a type.