Struct RealtimeClient 

pub struct RealtimeClient { /* private fields */ }

SignalR-over-WebSocket client for one ProjectX hub.

The transport owns no subscription truth. Reconnects emit RealtimeEvent::Reconnected, after which the caller replays its current subscription set.

Implementations

impl RealtimeClient

pub fn take_event_receiver(&self) -> Option<RealtimeEventReceiver>

Claims this client’s single event receiver.

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

Connects and validates the SignalR handshake.

Errors

Returns an error when authentication, URL construction, WebSocket upgrade, or the SignalR handshake fails.

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

Gracefully disconnects and stops background tasks.

Errors

Returns an error if the close handshake does not complete within the bounded timeout.

pub fn is_connected(&self) -> bool

Returns whether the latest connection completed its SignalR handshake.

pub fn session(&self) -> Result<RealtimeSession, RealtimeError>

Captures the current socket for generation-scoped subscription admission.

Errors

Returns RealtimeError::NotConnected unless a socket is ready.

pub async fn invoke( &self, target: impl Into<String>, arguments: Vec<Value>, ) -> Result<(), RealtimeError>

Invokes an arbitrary provider target and waits for its completion frame.

Errors

Returns an error when disconnected, a bounded capacity is exhausted, the provider rejects the invocation, or completion times out. A timeout or cancellation after queue admission has an unknown outcome and reclaims only that invocation slot. It never closes the connection or retries the call.

pub async fn subscribe_contract_trades( &self, contract: &ContractId, ) -> Result<(), RealtimeError>

Subscribes to market trades for a contract.

Errors

Returns a real-time invocation error.

pub async fn unsubscribe_contract_trades( &self, contract: &ContractId, ) -> Result<(), RealtimeError>

Unsubscribes from market trades for a contract.

Errors

Returns a real-time invocation error.

pub async fn subscribe_contract_quotes( &self, contract: &ContractId, ) -> Result<(), RealtimeError>

Subscribes to market quotes for a contract.

Errors

Returns a real-time invocation error.

pub async fn unsubscribe_contract_quotes( &self, contract: &ContractId, ) -> Result<(), RealtimeError>

Unsubscribes from market quotes for a contract.

Errors

Returns a real-time invocation error.

pub async fn subscribe_contract_depth( &self, contract: &ContractId, ) -> Result<(), RealtimeError>

Subscribes to market depth for a contract.

Errors

Returns a real-time invocation error.

pub async fn unsubscribe_contract_depth( &self, contract: &ContractId, ) -> Result<(), RealtimeError>

Unsubscribes from market depth for a contract.

Errors

Returns a real-time invocation error.

pub async fn subscribe_accounts(&self) -> Result<(), RealtimeError>

Subscribes to account updates.

Errors

Returns a real-time invocation error.

pub async fn unsubscribe_accounts(&self) -> Result<(), RealtimeError>

Unsubscribes from account updates.

Errors

Returns a real-time invocation error.

pub async fn subscribe_orders( &self, account: AccountId, ) -> Result<(), RealtimeError>

Subscribes to order updates for an account.

Errors

Returns a real-time invocation error.

pub async fn unsubscribe_orders( &self, account: AccountId, ) -> Result<(), RealtimeError>

Unsubscribes from order updates for an account.

Errors

Returns a real-time invocation error.

pub async fn subscribe_positions( &self, account: AccountId, ) -> Result<(), RealtimeError>

Subscribes to position updates for an account.

Errors

Returns a real-time invocation error.

pub async fn unsubscribe_positions( &self, account: AccountId, ) -> Result<(), RealtimeError>

Unsubscribes from position updates for an account.

Errors

Returns a real-time invocation error.

pub async fn subscribe_trades( &self, account: AccountId, ) -> Result<(), RealtimeError>

Subscribes to trade updates for an account.

Errors

Returns a real-time invocation error.

pub async fn unsubscribe_trades( &self, account: AccountId, ) -> Result<(), RealtimeError>

Unsubscribes from trade updates for an account.

Errors

Returns a real-time invocation error.

Trait Implementations

impl Clone for RealtimeClient

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RealtimeClient

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

Formats the value using the given formatter.

impl Drop for RealtimeClient

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.