Struct WebSocketSubscriptionStream 

pub struct WebSocketSubscriptionStream { /* private fields */ }

A connected WebSocket subscription whose background reader surfaces delivered messages.

Implementations

impl WebSocketSubscriptionStream

pub fn open( address: &str, channel: &str, accepted_schemas: Vec<SchemaId>, ) -> Result<Self, SdkError>

Connects to the ws:// address, performs the liminal handshake, subscribes to channel, and starts the background reader.

Deliveries the server coalesces with the SubscribeAck are retained and surfaced first, never dropped.

Errors

Returns SdkError::Connection when the client unit refuses the open or the socket cannot be opened, and SdkError::Protocol when the handshake or subscribe is rejected.

pub fn recv_timeout( &self, timeout: Duration, ) -> Result<WebSocketDeliveredMessage, SdkError>

Blocks up to timeout for the next delivered message.

Errors

Returns SdkError::Connection when no message arrives within timeout or the background reader has stopped.

pub const fn subscription_id(&self) -> u64

The server-assigned id for this subscription.

pub fn reconnect_state(&self) -> ReconnectState

The client unit’s reconnect state for this subscription’s connection.

Trait Implementations

impl Debug for WebSocketSubscriptionStream

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

Formats the value using the given formatter.

impl Drop for WebSocketSubscriptionStream

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.