Struct WsClient 

pub struct WsClient { /* private fields */ }

Async WebSocket client for exchange streaming APIs.

Implementations

impl WsClient

pub fn new(config: WsConfig) -> Self

Creates a new WebSocket client instance.

Arguments

• config - WebSocket connection configuration

Returns

A new WsClient instance ready to connect

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

Establishes connection to the WebSocket server.

Returns immediately if already connected. Automatically starts message processing loop and resubscribes to previous channels on success.

Errors

Returns error if:

• Connection timeout exceeded
• Network error occurs
• Server rejects connection

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

Closes the WebSocket connection gracefully.

Sends shutdown signal to background tasks and clears internal state.

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

Attempts to reconnect to the WebSocket server.

Respects max_reconnect_attempts configuration and waits for reconnect_interval before attempting connection.

Errors

Returns error if maximum reconnection attempts exceeded or connection fails.

pub async fn reconnect_count(&self) -> u32

Returns the current reconnection attempt count.

pub async fn reset_reconnect_count(&self)

Resets the reconnection attempt counter to zero.

pub async fn stats(&self) -> WsStats

Returns a snapshot of connection statistics.

pub async fn reset_stats(&self)

Resets all connection statistics to default values.

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

Calculates current connection latency in milliseconds.

Returns

Time difference between last pong and ping, or None if no data available.

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

Creates an automatic reconnection coordinator.

Returns

A new AutoReconnectCoordinator instance for managing reconnection logic.

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

Subscribes to a WebSocket channel.

Subscription is persisted and automatically reestablished on reconnection.

Arguments

• channel - Channel name to subscribe to
• symbol - Optional trading pair symbol
• params - Optional additional subscription parameters

Errors

Returns error if subscription message fails to send.

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

Unsubscribes from a WebSocket channel.

Removes subscription from internal state and sends unsubscribe message if connected.

Arguments

• channel - Channel name to unsubscribe from
• symbol - Optional trading pair symbol

Errors

Returns error if unsubscribe message fails to send.

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

Receives the next available message from the WebSocket stream.

Returns

The received JSON message, or None if the channel is closed.

pub async fn state(&self) -> WsConnectionState

Returns the current connection state.

pub async fn is_connected(&self) -> bool

Checks whether the WebSocket is currently connected.

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

Sends a raw WebSocket message.

Arguments

• message - WebSocket message to send

Errors

Returns error if not connected or message transmission fails.

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

Sends a text message over the WebSocket connection.

Arguments

• text - Text content to send

Errors

Returns error if not connected or transmission fails.

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

Sends a JSON-encoded message over the WebSocket connection.

Arguments

• json - JSON value to serialize and send

Errors

Returns error if serialization fails, not connected, or transmission fails.