Struct jsonrpsee_client_transport::ws::WsTransportClientBuilder

pub struct WsTransportClientBuilder {
    pub certificate_store: CertificateStore,
    pub connection_timeout: Duration,
    pub headers: HeaderMap,
    pub max_request_body_size: u32,
    pub max_redirections: usize,
}

Builder for a WebSocket transport Sender and [’Receiver`] pair.

Fields

certificate_store: CertificateStore

What certificate store to use

connection_timeout: Duration

Timeout for the connection.

headers: HeaderMap

Custom headers to pass during the HTTP handshake.

max_request_body_size: u32

Max payload size

max_redirections: usize

Max number of redirections.

Implementations

impl WsTransportClientBuilder

pub fn certificate_store(self, certificate_store: CertificateStore) -> Self

Set whether to use system certificates (default is native).

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

Set max request body size (default is 10 MB).

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

Set connection timeout for the handshake (default is 10 seconds).

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

Set a custom header passed to the server during the handshake (default is none).

The caller is responsible for checking that the headers do not conflict or are duplicated.

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

Set the max number of redirections to perform until a connection is regarded as failed. (default is 5).

impl WsTransportClientBuilder

pub async fn build(
    self,
    uri: Uri
) -> Result<(Sender, Receiver), WsHandshakeError>

Try to establish the connection.

Trait Implementations

impl Debug for WsTransportClientBuilder

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

Formats the value using the given formatter.

impl Default for WsTransportClientBuilder

fn default() -> Self

Returns the “default value” for a type.