Skip to main content

ConnectionEvent

Enum ConnectionEvent 

Source
pub enum ConnectionEvent {
    Connecting,
    Connected,
    Authenticated,
    Unauthenticated {
        message: String,
    },
    Disconnected {
        code: Option<u16>,
        reason: String,
        intent: DisconnectIntent,
    },
    Reconnecting {
        attempt: u32,
    },
    ReconnectFailed {
        attempts: u32,
    },
    HeartbeatTimeout {
        elapsed: Duration,
    },
    Error {
        message: String,
        code: i32,
    },
}
Expand description

Events emitted by WebSocket connection.

Consumers attribute events to their source client via the events() / state_events() Receiver they were yielded from — tokio::select! arms naturally label by source, and code that merges streams from multiple clients is expected to wrap with its own labeling adapter (3 lines via tokio_stream::StreamExt::map). The SDK does not pre-empt that decision by stuffing a label on every event.

Variants§

§

Connecting

Connection attempt started

§

Connected

Connection established

§

Authenticated

Authentication successful

§

Unauthenticated

Authentication rejected by the server (parallels old SDKs’ unauthenticated event)

Fields

§message: String

Server-provided rejection message.

§

Disconnected

Connection closed.

intent classifies the originator: Client for local-initiated, Server for a peer Close frame, Network for transport errors / EOF / heartbeat timeout.

Fields

§code: Option<u16>

WebSocket close code, if the peer supplied one.

§reason: String

Human-readable close reason (may be empty).

§intent: DisconnectIntent

Who initiated the disconnect.

§

Reconnecting

Reconnection attempt started

Fields

§attempt: u32

Current attempt number (1-indexed).

§

ReconnectFailed

Reconnection failed after max attempts

Fields

§attempts: u32

Total attempts performed before giving up.

§

HeartbeatTimeout

Heartbeat timeout: no inbound frame received within the configured heartbeat_timeout window. Emitted by the dispatch loop when the read-site timeout fires; the dispatch loop returns immediately afterwards, which lets the reconnect path take over.

Fields

§elapsed: Duration

Wall-clock interval that elapsed since the last inbound frame.

§

Error

Error occurred

Fields

§message: String

Diagnostic message describing the error.

§code: i32

Numeric error code (mirrors MarketDataError::to_error_code).

Trait Implementations§

Source§

impl Clone for ConnectionEvent

Source§

fn clone(&self) -> ConnectionEvent

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ConnectionEvent

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for ConnectionEvent

Source§

fn eq(&self, other: &ConnectionEvent) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for ConnectionEvent

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V