Struct jsonrpsee_ws_client::client::WsConfig

pub struct WsConfig<'a> {
    pub url: &'a str,
    pub max_request_body_size: usize,
    pub request_timeout: Option<Duration>,
    pub connection_timeout: Duration,
    pub origin: Option<Cow<'a, str>>,
    pub handshake_url: Cow<'a, str>,
    pub max_concurrent_requests: usize,
    pub max_notifs_per_subscription: usize,
}

Configuration.

Fields

url: &'a str

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

max_request_body_size: usize

Max request body size

request_timeout: Option<Duration>

Request timeout

connection_timeout: Duration

Connection timeout

origin: Option<Cow<'a, str>>

Origin header to pass during the HTTP handshake. If None, no Origin header was passed.

handshake_url: Cow<'a, str>

Url to send during the HTTP handshake.

max_concurrent_requests: usize

Max concurrent request.

max_notifs_per_subscription: usize

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

Implementations

impl<'a> WsConfig<'a>

pub fn with_url(url: &'a str) -> Self

Default WebSocket configuration with a specified URL to connect to.

Trait Implementations

impl<'a> Clone for WsConfig<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for WsConfig<'a>

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

Formats the value using the given formatter.

impl<'a> TryFrom<WsConfig<'a>> for WsTransportClientBuilder<'a>

type Error = WsHandshakeError

The type returned in the event of a conversion error.

fn try_from(config: WsConfig<'a>) -> Result<Self, Self::Error>

Performs the conversion.