Struct jsonrpsee_ws_client::client::WsClient

pub struct WsClient { /* fields omitted */ }

WebSocket client that works by maintaining a background task running in parallel.

It’s possible that the background thread is terminated and this makes the client unusable. An error Error::RestartNeeded is returned if this happens and users has to manually handle dropping and restarting a new client.

Implementations

impl WsClient

pub fn is_connected(&self) -> bool

Checks if the client is connected to the target.

Trait Implementations

impl Client for WsClient

fn notification<'life0, 'async_trait, M, P>(
    &'life0 self,
    method: M,
    params: P
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>> where
    M: Into<String> + Send,
    P: Into<Params> + Send,
    M: 'async_trait,
    P: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Send a notification to the server.

fn request<'life0, 'async_trait, T, M, P>(
    &'life0 self,
    method: M,
    params: P
) -> Pin<Box<dyn Future<Output = Result<T, Error>> + Send + 'async_trait>> where
    T: DeserializeOwned,
    M: Into<String> + Send,
    P: Into<Params> + Send,
    T: 'async_trait,
    M: 'async_trait,
    P: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Perform a request towards the server.

fn batch_request<'life0, 'async_trait, T, M, P>(
    &'life0 self,
    batch: Vec<(M, P)>
) -> Pin<Box<dyn Future<Output = Result<Vec<T>, Error>> + Send + 'async_trait>> where
    T: DeserializeOwned + Default + Clone,
    M: Into<String> + Send,
    P: Into<Params> + Send,
    T: 'async_trait,
    M: 'async_trait,
    P: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Send a batch request.

impl Debug for WsClient

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

Formats the value using the given formatter.

impl SubscriptionClient for WsClient

fn subscribe<'life0, 'async_trait, SM, UM, P, N>(
    &'life0 self,
    subscribe_method: SM,
    params: P,
    unsubscribe_method: UM
) -> Pin<Box<dyn Future<Output = Result<Subscription<N>, Error>> + Send + 'async_trait>> where
    SM: Into<String> + Send,
    UM: Into<String> + Send,
    P: Into<Params> + Send,
    N: DeserializeOwned,
    SM: 'async_trait,
    UM: 'async_trait,
    P: 'async_trait,
    N: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Send a subscription request to the server.

The subscribe_method and params are used to ask for the subscription towards the server. The unsubscribe_method is used to close the subscription.