Struct DeriveWebSocketClient 

pub struct DeriveWebSocketClient { /* private fields */ }

WebSocket client for the Derive JSON-RPC stream.

Construct with Self::new (public-only) or Self::with_credentials when private channels and signed actions are needed. Call Self::connect before any subscribe call; Self::disconnect tears the connection down.

Implementations

impl DeriveWebSocketClient

pub fn new( url: Option<String>, environment: DeriveEnvironment, transport_backend: TransportBackend, proxy_url: Option<String>, ) -> Self

Builds a public-only client. URL falls back to the environment default when url is None.

pub fn with_credentials( url: Option<String>, environment: DeriveEnvironment, transport_backend: TransportBackend, proxy_url: Option<String>, credentials: DeriveWsCredentials, max_matching_requests_per_second: Option<u32>, max_per_instrument_matching_requests_per_second: Option<u32>, ) -> Self

Builds a client that will issue public/login on connect and replay it after each reconnect.

max_matching_requests_per_second sets the shared wallet matching allowance. max_per_instrument_matching_requests_per_second sets the independent token refill rate for perpetuals, spot, and options. Unset values preserve existing shared settings or use reference defaults. Clients for the same wallet on the same API host share the first explicit settings. See crate::common::rate_limit.

pub fn with_socket_control(self, control: SocketControl) -> Self

Configures socket state reporting and reconnect control.

pub fn url(&self) -> &str

Returns the configured WebSocket URL.

pub fn set_request_timeout(&mut self, timeout: Duration)

Sets the per-operation WebSocket timeout (login, subscribe, reads, writes).

Must be called before connect(). Defaults to WS_REQUEST_TIMEOUT.

pub fn is_authenticated(&self) -> bool

Returns true when credentials are configured and the venue has confirmed the latest public/login. Cleared on reconnect.

pub fn is_active(&self) -> bool

Returns true while the underlying transport is in the active state.

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

Establishes the WebSocket connection and spawns the I/O handler task.

When credentials are configured, issues public/login and awaits the venue’s acknowledgement before returning.

Errors

Returns an error if the WebSocket handshake or login flow fails.

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

Disconnects the WebSocket connection and awaits the handler task.

Errors

Returns an error if the disconnect command cannot be enqueued; the handler still tears down on signal.

pub async fn subscribe_ticker( &self, instrument_name: &str, interval: &str, ) -> Result<()>

Subscribes to ticker_slim.{instrument_name}.{interval}. interval is the millisecond cadence string the venue exposes (e.g. "100", "1000").

Errors

Returns an error if the venue raises a JSON-RPC error or the transport fails.

pub async fn unsubscribe_ticker( &self, instrument_name: &str, interval: &str, ) -> Result<()>

Unsubscribes from ticker_slim.{instrument_name}.{interval}.

Errors

Returns an error if the venue raises a JSON-RPC error or the transport fails.

pub async fn subscribe_orderbook( &self, instrument_name: &str, group: &str, depth: &str, ) -> Result<()>

Subscribes to orderbook.{instrument_name}.{group}.{depth}.

Errors

Returns an error if the venue raises a JSON-RPC error or the transport fails.

pub async fn unsubscribe_orderbook( &self, instrument_name: &str, group: &str, depth: &str, ) -> Result<()>

Unsubscribes from orderbook.{instrument_name}.{group}.{depth}.

Errors

Returns an error if the venue raises a JSON-RPC error or the transport fails.

pub async fn subscribe_trades( &self, instrument_type: &str, currency: &str, ) -> Result<()>

Subscribes to trades.{instrument_type}.{currency}.

Errors

Returns an error if the venue raises a JSON-RPC error or the transport fails.

pub async fn unsubscribe_trades( &self, instrument_type: &str, currency: &str, ) -> Result<()>

Unsubscribes from trades.{instrument_type}.{currency}.

Errors

Returns an error if the venue raises a JSON-RPC error or the transport fails.

pub async fn subscribe_channels<C>(&self, channels: Vec<C>) -> Result<()>

where C: Into<DeriveWsChannel>,

Subscribes to a list of channel topics in a single subscribe frame.

Used by the execution client to bulk-subscribe to the private {subaccount_id}.orders, {subaccount_id}.trades, and {subaccount_id}.balances channels after login.

Errors

Returns an error if the venue raises a JSON-RPC error or the transport fails.

pub async fn unsubscribe_channels<C>(&self, channels: Vec<C>) -> Result<()>

where C: Into<DeriveWsChannel>,

Unsubscribes from a list of channel topics in a single unsubscribe frame.

Errors

Returns an error if the venue raises a JSON-RPC error or the transport fails.

pub async fn next_event(&mut self) -> Option<DeriveWsMessage>

Returns the next event emitted by the handler.

pub fn subscription_count(&self) -> usize

Returns the count of channels the client currently has confirmed subscriptions for.

pub fn subscription_handle(&self) -> DeriveWebSocketSubscriptionHandle

Returns a cloneable handle for issuing subscription commands.

pub fn execution_handle(&self) -> DeriveWsExecutionHandle

Returns a cloneable handle for issuing signed private/* trading requests.

The handle shares the client’s command channel, so it stays valid across reconnects (the channel is swapped behind a shared lock). Obtain it once and clone it into each order-submission task.

pub fn take_event_receiver( &mut self, ) -> Option<UnboundedReceiver<DeriveWsMessage>>

Takes the event receiver from the client.

This lets the live data client own the receive loop while subscription commands continue through Self::subscription_handle.

Trait Implementations

impl Debug for DeriveWebSocketClient

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

Formats the value using the given formatter.

impl Drop for DeriveWebSocketClient

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.