Struct CoinbaseWebSocketClient 

pub struct CoinbaseWebSocketClient { /* private fields */ }

WebSocket client for Coinbase Advanced Trade market data and user streams.

Manages connection lifecycle, subscription state, and JWT authentication. Spawns a FeedHandler task that parses raw messages into Nautilus types.

Implementations

impl CoinbaseWebSocketClient

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

Creates a new CoinbaseWebSocketClient for public market data.

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

Configures socket state reporting and reconnect control.

pub fn with_credential( url: &str, credential: CoinbaseCredential, transport_backend: TransportBackend, proxy_url: Option<String>, ) -> Self

Creates a new CoinbaseWebSocketClient with credentials for authenticated channels.

pub async fn set_account_id(&mut self, account_id: AccountId)

Sets the account ID used when emitting user-channel execution reports.

Propagates to the feed handler when the connection is active so that subsequent user events carry the correct account identifier.

pub async fn initialize_instruments(&self, instruments: Vec<InstrumentAny>)

Bulk-populates the instrument cache.

Safe to call before or after Self::connect. When called before connect, instruments are picked up by the initial InitializeInstruments command the client sends to the handler; when called after, a fresh InitializeInstruments command is sent to refresh the handler’s cache.

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

Establishes the WebSocket connection and spawns the feed handler.

pub async fn subscribe( &self, channel: CoinbaseWsChannel, product_ids: &[Ustr], ) -> Result<()>

Subscribes to a channel for the given product IDs.

pub async fn unsubscribe( &self, channel: CoinbaseWsChannel, product_ids: &[Ustr], ) -> Result<()>

Unsubscribes from a channel for the given product IDs.

pub async fn next_message(&mut self) -> Option<NautilusWsMessage>

Returns the next parsed message from the feed handler.

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

Disconnects the WebSocket and stops the feed handler.

pub fn is_active(&self) -> bool

Returns true if the WebSocket connection is active.

pub fn is_reconnecting(&self) -> bool

Returns true if the WebSocket is reconnecting after a transport drop.

pub fn instruments(&self) -> &Arc<AtomicMap<InstrumentId, InstrumentAny>>

Returns a reference to the instrument cache.

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

Returns a reference to the canonical-to-subscribed alias map.

pub fn register_subscription_alias(&self, canonical: Ustr, subscribed: Ustr)

Records that inbound messages carrying canonical should be re-keyed to subscribed. Caller is the data/exec client at subscribe or submit time when the local product id differs from Coinbase’s canonical alias.

pub fn unregister_subscription_alias(&self, canonical: &Ustr)

Removes an alias registration. Safe to call if no entry exists.

pub fn subscriptions(&self) -> &SubscriptionState

Returns the subscription state.

pub async fn update_instrument(&self, instrument: InstrumentAny)

Updates an instrument in the cache and notifies the handler.

pub fn take_out_rx(&mut self) -> Option<UnboundedReceiver<NautilusWsMessage>>

Takes the output message receiver, leaving None in its place.

Used by the data client to move the receiver into a background consumption task.

pub fn register_bar_type(&mut self, key: String, bar_type: BarType)

Registers a bar type locally without notifying the handler.

Used by the data client to persist registrations on the original client before cloning for async command dispatch.

pub async fn add_bar_type(&mut self, key: String, bar_type: BarType)

Registers a bar type for candle parsing.

Trait Implementations

impl Clone for CoinbaseWebSocketClient

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 CoinbaseWebSocketClient

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

Formats the value using the given formatter.

impl Drop for CoinbaseWebSocketClient

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.