Skip to main content

WsManager

Struct WsManager 

Source
pub struct WsManager { /* private fields */ }
Expand description

Manages a single WebSocket feed: connect, receive, reconnect.

Call WsManager::run to enter the connection loop. Messages are forwarded to the mpsc::Sender supplied to run; the loop retries on disconnection according to the ReconnectPolicy in the ConnectionConfig.

Implementations§

Source§

impl WsManager

Source

pub fn new(config: ConnectionConfig) -> Self

Create a new manager from a validated ConnectionConfig.

Source

pub async fn run( &mut self, message_tx: Sender<String>, outbound_rx: Option<Receiver<String>>, ) -> Result<(), StreamError>

Run the WebSocket connection loop, forwarding text messages to message_tx.

The loop connects, reads frames until the socket closes or errors, then waits the configured backoff and reconnects. Returns when either:

outbound_rx is an optional channel for sending messages to the server (e.g., subscription requests). When provided, any string received on this channel is forwarded to the WebSocket as a text frame.

§Errors

Returns StreamError::ReconnectExhausted after all reconnect slots are consumed, or the underlying connection error if reconnects are exhausted immediately on the first attempt.

Source

pub fn connect_simulated(&mut self)

Simulate a connection (for testing without live WebSocket). Increments connect_attempts to reflect the initial connection slot.

Source

pub fn disconnect_simulated(&mut self)

Simulate a disconnection.

Source

pub fn is_connected(&self) -> bool

Whether the managed connection is currently in the connected state.

Source

pub fn connect_attempts(&self) -> u32

Total connection attempts made so far (including the initial connect).

Source

pub fn config(&self) -> &ConnectionConfig

The configuration this manager was created with.

Source

pub fn stats(&self) -> &WsStats

Cumulative receive statistics for this manager.

Source

pub fn can_reconnect(&self) -> bool

Check whether the next reconnect attempt is allowed.

Source

pub fn next_reconnect_backoff(&mut self) -> Result<Duration, StreamError>

Consume a reconnect slot and return the backoff duration to wait.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more