Struct AxOrdersWebSocketClient 

pub struct AxOrdersWebSocketClient { /* private fields */ }

Orders WebSocket client for Ax.

Provides authenticated order management including placing, canceling, and monitoring order status via WebSocket.

Implementations

impl AxOrdersWebSocketClient

pub fn new( url: String, account_id: AccountId, trader_id: TraderId, heartbeat: u64, transport_backend: TransportBackend, proxy_url: Option<String>, ) -> Self

Creates a new Ax orders WebSocket client.

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

Configures socket state reporting and reconnect control.

pub fn url(&self) -> &str

Returns the WebSocket URL.

pub fn account_id(&self) -> AccountId

Returns the account ID.

pub fn is_active(&self) -> bool

Returns whether the client is currently connected and active.

pub fn is_closed(&self) -> bool

Returns whether the client is closed.

pub fn cache_instrument(&self, instrument: InstrumentAny)

Caches an instrument for use during message parsing.

pub fn cache_instruments(&self, instruments: &[InstrumentAny])

Caches multiple instruments for use during message parsing.

pub fn update_auth_token(&self, token: &str) -> AxOrdersWsResult<()>

Updates the token used by future automatic reconnect attempts.

Updating the token does not interrupt the active WebSocket connection.

Errors

Returns an error if the reconnect header cannot be updated.

pub fn get_cached_instrument(&self, symbol: &Ustr) -> Option<InstrumentAny>

Returns a cached instrument by symbol.

pub fn caches(&self) -> &OrdersCaches

Returns the shared order caches.

pub fn instruments_cache(&self) -> Arc<AtomicMap<Ustr, InstrumentAny>>

Returns the instruments cache.

pub fn orders_metadata(&self) -> &Arc<DashMap<ClientOrderId, OrderMetadata>>

Returns the orders metadata cache.

pub fn cid_to_client_order_id(&self) -> &Arc<DashMap<u64, ClientOrderId>>

Returns the cid to client order ID mapping for order correlation.

pub fn resolve_cid(&self, cid: u64) -> Option<ClientOrderId>

Resolves a cid to a ClientOrderId if the mapping exists.

pub fn register_external_order( &self, client_order_id: ClientOrderId, venue_order_id: VenueOrderId, instrument_id: InstrumentId, strategy_id: StrategyId, ) -> bool

Registers an external order with the WebSocket handler for event tracking.

This allows the handler to create proper events (e.g., OrderCanceled, OrderFilled) for orders that were reconciled externally and not submitted through this client.

Returns false if the instrument is not cached (registration skipped).

pub async fn connect(&mut self, bearer_token: &str) -> AxOrdersWsResult<()>

Establishes the WebSocket connection with authentication.

Arguments

• bearer_token - The bearer token for authentication.

Errors

Returns an error if the connection cannot be established.

pub async fn submit_order( &self, trader_id: TraderId, strategy_id: StrategyId, instrument_id: InstrumentId, client_order_id: ClientOrderId, order_side: OrderSide, quantity: Quantity, time_in_force: TimeInForce, price: Price, post_only: bool, ) -> AxOrdersWsResult<i64>

Submits the AX priced order shape using Nautilus domain types.

This method handles conversion from Nautilus domain types to AX-specific types and stores order metadata for event correlation.

Errors

Returns an error if:

• The time-in-force is not supported.
• The instrument is not found in the cache.
• The order command cannot be sent.

pub async fn cancel_order( &self, client_order_id: ClientOrderId, venue_order_id: Option<VenueOrderId>, ) -> AxOrdersWsResult<i64>

Cancels an order via WebSocket.

Requires a known venue_order_id.

Errors

Returns an error if the cancel command cannot be sent.

pub async fn get_open_orders(&self) -> AxOrdersWsResult<i64>

Requests open orders via WebSocket.

Errors

Returns an error if the request command cannot be sent.

pub fn stream(&mut self) -> impl Stream<Item = AxOrdersWsMessage> + 'static

Returns a stream of WebSocket messages.

Panics

Panics if called before connect() or if the stream has already been taken.

pub async fn disconnect(&self)

Disconnects the WebSocket connection gracefully.

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

Closes the WebSocket connection and cleans up resources.

Errors

Returns an error if the handler task fails or does not stop after abort.

Trait Implementations

impl Clone for AxOrdersWebSocketClient

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 AxOrdersWebSocketClient

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

Formats the value using the given formatter.

impl Drop for AxOrdersWebSocketClient

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.