Skip to main content

Client

Struct Client 

Source
pub struct Client { /* private fields */ }
Available on crate feature blocking only.
Expand description

The blocking client. Cheap to clone; dropping the last clone the user holds disconnects (bounded, as Client::disconnect) and stops the runtime. The clients handed to handlers are for the duration of the call; do not keep them after the last user handle is gone.

Implementations§

Source§

impl Client

Source

pub fn as_async(&self) -> &Client

The async client behind this one.

Source

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

See crate::Client::emit (never blocks).

Source

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

See crate::Client::emit_with_ack; blocks until the ack, the timeout or the loss.

Source

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

See crate::Client::disconnect; blocks (bounded).

Source

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

See crate::Client::reconnect; blocks until the attempt ends.

Source

pub fn on<F>(&self, event: impl Into<String>, handler: F) -> ListenerId
where F: Fn(Event, Client) + Send + Sync + 'static,

Adds a handler for event.

Source

pub fn once<F>(&self, event: impl Into<String>, handler: F) -> ListenerId
where F: Fn(Event, Client) + Send + Sync + 'static,

Adds a handler for the next event.

Source

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

Removes every handler of event.

Source

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

Removes one handler.

Source

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

Number of handlers of event.

Source

pub fn state(&self) -> ConnectionState

The current state.

Source

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

Blocks until the state matches predicate, the client closed, or timeout passed; returns the state then.

Source

pub fn connected(&self) -> bool

The namespace is joined right now.

Source

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

The socket id while connected.

Source

pub fn namespace(&self) -> &str

The namespace.

A snapshot of the link.

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

impl Drop for Client

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

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. 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