Skip to main content

WsClient

Struct WsClient 

Source
pub struct WsClient {
    pub url: String,
    pub state: WsState,
    pub auto_reconnect: bool,
    pub max_reconnects: u32,
    pub ping_interval: Duration,
    pub pong_timeout: Duration,
    pub max_queue_size: usize,
    /* private fields */
}
Expand description

WebSocket client driven by tick().

Fields§

§url: String§state: WsState§auto_reconnect: bool

Auto-reconnect on unexpected disconnect.

§max_reconnects: u32

Max reconnect attempts before giving up (0 = unlimited).

§ping_interval: Duration

Keepalive ping interval.

§pong_timeout: Duration

Close connection if no pong received within this time.

§max_queue_size: usize

Max size of outbound queue.

Implementations§

Source§

impl WsClient

Source

pub fn new(url: impl Into<String>) -> Self

Source

pub fn connect(&mut self)

Initiate a connection. No-op if already connected.

Source

pub fn close(&mut self)

Close the connection intentionally (will not auto-reconnect).

Source

pub fn disconnect(&mut self)

Disconnect but allow auto-reconnect.

Source

pub fn send(&mut self, message: WsMessage) -> bool

Send a message. Queued if not currently connected.

Source

pub fn send_on_channel(&mut self, channel: &str, message: WsMessage) -> bool

Send a message on a named channel.

Source

pub fn subscribe(&mut self, channel: impl Into<String>)

Subscribe to a named logical channel.

Source

pub fn unsubscribe(&mut self, channel: &str)

Source

pub fn tick(&mut self, dt: f32)

Drive the WebSocket state machine. Call once per frame.

Source

pub fn drain_events(&mut self) -> impl Iterator<Item = WsEvent> + '_

Source

pub fn is_connected(&self) -> bool

Source

pub fn messages_sent(&self) -> u64

Source

pub fn messages_received(&self) -> u64

Source

pub fn bytes_sent(&self) -> u64

Source

pub fn bytes_received(&self) -> u64

Source

pub fn uptime(&self) -> Option<Duration>

Source

pub fn pending_outbound(&self) -> usize

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

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, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

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<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
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,