Struct BetfairStreamClient 

pub struct BetfairStreamClient { /* private fields */ }

Betfair Exchange Stream API client using raw TLS (CRLF-delimited JSON).

On connect, authenticates immediately. On reconnection, replays authentication and any active subscriptions with the latest clk token for delta resumption.

The auth bytes are stored in a watch channel so the caller can push refreshed session tokens via update_auth after keep-alive or HTTP reconnect. The closed flag distinguishes permanent shutdown from transient reconnect.

Implementations

impl BetfairStreamClient

pub async fn connect( credential: &BetfairCredential, session_token: String, handler: TcpMessageHandler, config: BetfairStreamConfig, ) -> Result<Self, BetfairStreamError>

Connects to the Betfair stream API and authenticates.

Errors

Returns an error if the connection fails or authentication cannot be sent.

pub async fn subscribe_markets( &self, market_filter: StreamMarketFilter, data_filter: MarketDataFilter, heartbeat_ms: Option<u64>, conflate_ms: Option<u64>, ) -> Result<(), BetfairStreamError>

Subscribes to market data for the given filter and data fields.

Stores the subscription for automatic replay on reconnection.

Errors

Returns an error if serialization or sending fails.

pub async fn subscribe_orders( &self, order_filter: Option<OrderFilter>, heartbeat_ms: Option<u64>, ) -> Result<(), BetfairStreamError>

Subscribes to order updates.

Stores the subscription for automatic replay on reconnection.

Errors

Returns an error if serialization or sending fails.

pub fn is_active(&self) -> bool

Returns true if the connection is active.

pub fn authentication_state(&self) -> StreamLifecycleState

pub fn market_subscription_state(&self) -> StreamLifecycleState

pub fn order_subscription_state(&self) -> StreamLifecycleState

pub async fn wait_for_authentication_state( &self, expected: StreamLifecycleState, )

Waits for the authentication lifecycle component to equal expected.

Returns immediately if the component is already in the exact expected state; otherwise waits for a later transition. A transient expected state that is replaced before this task observes it can be missed because transitions are not recorded as history. This method has no internal timeout; callers wanting a bound should wrap it in [tokio::time::timeout].

pub async fn wait_for_market_subscription_state( &self, expected: StreamLifecycleState, )

Waits for the market subscription lifecycle component to equal expected.

Returns immediately if the component is already in the exact expected state; otherwise waits for a later transition. A transient expected state that is replaced before this task observes it can be missed because transitions are not recorded as history. This method has no internal timeout; callers wanting a bound should wrap it in [tokio::time::timeout].

pub async fn wait_for_order_subscription_state( &self, expected: StreamLifecycleState, )

Waits for the order subscription lifecycle component to equal expected.

Returns immediately if the component is already in the exact expected state; otherwise waits for a later transition. A transient expected state that is replaced before this task observes it can be missed because transitions are not recorded as history. This method has no internal timeout; callers wanting a bound should wrap it in [tokio::time::timeout].

pub fn is_authenticated(&self) -> bool

pub fn is_market_ready(&self) -> bool

pub fn is_order_ready(&self) -> bool

pub fn update_auth(&self, app_key: &str, session_token: String)

Pushes refreshed auth bytes so the next reconnection or subscription uses the current session token instead of the one from initial connect.

pub fn request_reconnect(&self) -> bool

Requests replacement of the active stream transport.

Returns true only when this call starts a reconnect. Duplicate requests and requests after close return false.

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

Closes the stream connection.

Errors

Returns an error if the dead-peer task fails or does not stop after abort.

Trait Implementations

impl Debug for BetfairStreamClient

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

Formats the value using the given formatter.

impl Drop for BetfairStreamClient

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.