Struct WsClient 

pub struct WsClient { /* private fields */ }

Async WebSocket client for exchange streaming APIs.

Backpressure Handling

This client uses bounded channels to prevent memory exhaustion in high-frequency trading scenarios. When the message channel is full, the configured BackpressureStrategy determines how to handle new messages:

• DropOldest: Removes the oldest message to make room (default)
• DropNewest: Discards the incoming message
• Block: Waits until space is available (may stall the read loop)

Implementations

impl WsClient

pub fn new(config: WsConfig) -> WsClient

Creates a new WebSocket client instance.

The client uses bounded channels for message passing to prevent memory exhaustion. Channel capacities are configured via WsConfig.

pub async fn set_event_callback( &self, callback: Arc<dyn Fn(WsEvent) + Send + Sync>, )

Sets the event callback for connection lifecycle events.

pub async fn clear_event_callback(&self)

Clears the event callback.

pub async fn set_cancel_token(&self, token: CancellationToken)

Sets the cancellation token for this client.

pub async fn clear_cancel_token(&self)

Clears the cancellation token.

pub async fn get_cancel_token(&self) -> Option<CancellationToken>

Returns a clone of the current cancellation token, if set.

pub async fn connect(&self) -> Result<(), Error>

Establishes connection to the WebSocket server.

pub async fn connect_with_cancel( &self, cancel_token: Option<CancellationToken>, ) -> Result<(), Error>

Establishes connection with cancellation support.

pub async fn disconnect(&self) -> Result<(), Error>

Closes the WebSocket connection gracefully.

pub async fn shutdown(&self)

Gracefully shuts down the WebSocket client.

pub async fn reconnect(&self) -> Result<(), Error>

Attempts to reconnect to the WebSocket server.

pub async fn reconnect_with_cancel( &self, cancel_token: Option<CancellationToken>, ) -> Result<(), Error>

Attempts to reconnect with cancellation support.

pub fn reconnect_count(&self) -> u32

Returns the current reconnection attempt count.

pub fn reset_reconnect_count(&self)

Resets the reconnection attempt counter.

pub fn stats(&self) -> WsStatsSnapshot

Returns a snapshot of connection statistics.

pub fn reset_stats(&self)

Resets all connection statistics.

pub fn latency(&self) -> Option<i64>

Calculates current connection latency in milliseconds.

pub fn dropped_messages(&self) -> u32

Returns the number of messages dropped due to backpressure.

This counter is incremented when the message channel is full and messages are dropped according to the configured backpressure strategy.

pub fn reset_dropped_messages(&self)

Resets the dropped messages counter.

pub fn create_auto_reconnect_coordinator( self: Arc<WsClient>, ) -> AutoReconnectCoordinator

Creates an automatic reconnection coordinator.

pub async fn subscribe( &self, channel: String, symbol: Option<String>, params: Option<HashMap<String, Value>>, ) -> Result<(), Error>

Subscribes to a WebSocket channel.

pub async fn unsubscribe( &self, channel: String, symbol: Option<String>, ) -> Result<(), Error>

Unsubscribes from a WebSocket channel.

pub async fn receive(&self) -> Option<Value>

Receives the next available message.

pub fn state(&self) -> WsConnectionState

Returns the current connection state.

pub fn config(&self) -> &WsConfig

Returns a reference to the WebSocket configuration.

pub fn set_state(&self, state: WsConnectionState)

Sets the connection state.

pub fn is_connected(&self) -> bool

Checks whether the WebSocket is currently connected.

pub fn is_subscribed(&self, channel: &str, symbol: Option<&String>) -> bool

Checks if subscribed to a specific channel.

pub fn subscription_count(&self) -> usize

Returns the number of active subscriptions.

pub fn remaining_capacity(&self) -> usize

Returns the remaining capacity for new subscriptions.

pub fn subscriptions(&self) -> Vec<String>

Returns a list of all active subscription channel names.

Each subscription is identified by its channel name, optionally combined with a symbol in the format “channel:symbol” or just “channel”.

pub async fn send(&self, message: Message) -> Result<(), Error>

Sends a raw WebSocket message.

This method uses a bounded channel for sending. If the write channel is full, it will wait until space is available.

pub fn try_send(&self, message: Message) -> Result<(), Error>

Tries to send a raw WebSocket message without blocking.

Returns an error if the channel is full or closed.

pub async fn send_text(&self, text: String) -> Result<(), Error>

Sends a text message.

pub async fn send_json(&self, json: &Value) -> Result<(), Error>

Sends a JSON-encoded message.

Trait Implementations

impl Debug for WsClient

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

Formats the value using the given formatter.