Skip to main content

Client

Struct Client 

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

A connected socket.io client (one namespace). Cheap to clone; all clones are one client.

Dropping the last clone closes the connection. Handlers get a clone for the duration of the call.

Implementations§

Source§

impl Client

Source

pub async fn reconnect(&self) -> Result<()>

Connects again after the client closed (a ConnectRejected, ReconnectFailed, a server disconnect without reconnect_on_disconnect, or disconnect()), with the same handlers and options; auth_with and connect_params_with run again, so a new token can be handed in first. Resolves like connect(): once the server accepted the namespace, or with the error of that attempt (the client then stays closed). A no-op while the client is not closed. Must not be called from one of its handlers.

Source

pub fn emit( &self, event: impl AsRef<str>, data: impl Into<Payload>, ) -> Result<()>

Sends event with data (Payload, serde_json::Value, a string, bytes, () for no arguments). Never blocks: the packet is queued for the connection task.

Fails with Error::NotConnected while disconnected (unless buffer_while_disconnected), Error::Closed after the client closed, and Error::ReservedEvent for connect, disconnect, …

Source

pub async fn emit_with_ack( &self, event: impl AsRef<str>, data: impl Into<Payload>, timeout: Duration, ) -> Result<Payload>

Sends event and waits for the server’s ack (socket.io-client socket.timeout(ms).emitWithAck(...)). Resolves with the ack’s arguments, or fails with Error::AckTimeout after timeout, Error::Disconnected when the connection drops first. Dropping the future forgets the ack.

Source

pub fn on<M>( &self, event: impl Into<String>, handler: impl Handler<Event, M>, ) -> ListenerId

Adds a handler for event; returns its id for off_listener.

Source

pub fn once<M>( &self, event: impl Into<String>, handler: impl Handler<Event, M>, ) -> ListenerId

Adds a handler for the next event only.

Source

pub fn on_any<M>(&self, handler: impl Handler<Event, M>) -> ListenerId

Adds a handler for every event (socket.io-client onAny).

Source

pub fn on_state_change<M>( &self, handler: impl Handler<ConnectionState, M>, ) -> ListenerId

Adds a handler for every ConnectionState transition.

Source

pub fn off(&self, event: &str) -> usize

Removes every handler of event; returns how many.

Source

pub fn off_any(&self) -> usize

Removes every catch-all handler; returns how many.

Source

pub fn off_listener(&self, id: ListenerId) -> bool

Removes one handler; false when it was gone already (a once handler that ran).

Source

pub fn listener_count(&self, event: &str) -> usize

Number of handlers of event (socket.io-client listeners(event).length).

Source

pub fn state(&self) -> ConnectionState

The current state.

Source

pub fn state_watch(&self) -> Receiver<ConnectionState>

A watch of the state: changed().await wakes on transitions (a slow reader sees the latest; use on_state_change to see every one).

Source

pub async fn wait_for( &self, predicate: impl Fn(&ConnectionState) -> bool, ) -> ConnectionState

Waits until the state matches predicate (or the client closed).

Source

pub fn connected(&self) -> bool

The namespace is joined right now.

Source

pub fn id(&self) -> Option<String>

The socket id while connected (socket.id).

Source

pub fn namespace(&self) -> &str

The namespace of this client.

Source

pub fn recovered(&self) -> bool

The last connect restored the session (connection state recovery, socket.recovered).

A snapshot of the link: transport, sids, heartbeat, last packet, attempts.

Source

pub async fn disconnect(&self) -> Result<()>

Leaves the namespace (DISCONNECT packet), closes the connection and stops reconnecting.

Bounded: the goodbye (queued packets, DISCONNECT, engine.io close) gets at most 2 s on a dead link. Events already received are still handled; handlers get up to 5 s in total, then the event task is stopped. When it returns no handler starts any more. Safe to call from inside a handler (it then does not wait for the handlers; the event task ends after the running handler).

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Self

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 Client

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Client

§

impl !UnwindSafe for Client

§

impl Forget for Client

§

impl Freeze for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl UnsafeUnpin for Client

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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 = !

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

fn try_from(value: U) -> Result<T, !>

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