Skip to main content

ClientBuilder

Struct ClientBuilder 

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

Configures and opens an engine.io Client.

build* performs the handshake; Client::connect then starts the session.

Implementations§

Source§

impl ClientBuilder

Source

pub fn new(url: Url) -> Self

A builder for url. EIO=4 is added to the query; an empty path becomes /engine.io/. The engine.io parameters (EIO, transport, sid, t, b64) are the client’s own: a caller’s values for them are dropped, as engine.io-client overrides them.

Source

pub fn tls_config(self, tls_config: impl Into<TlsConfig>) -> Self

Available on crate features native-tls or rustls only.

TLS configuration for https/wss (default: the backend’s default roots).

Source

pub fn headers(self, headers: HeaderMap) -> Self

HTTP headers for every polling request and the websocket handshake.

Source

pub fn timeout(self, timeout: Duration) -> Self

Bound for the handshake and the websocket connect (default 20 s).

Source

pub fn on_close<F, Fut>(self, callback: F) -> Self
where F: Fn(()) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Called when the session closes (server close packet or Client::disconnect).

Source

pub fn on_data<F, Fut>(self, callback: F) -> Self
where F: Fn(Bytes) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Called with the data of every message packet.

Source

pub fn on_error<F, Fut>(self, callback: F) -> Self
where F: Fn(String) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Called with the text of every send error.

Source

pub fn on_open<F, Fut>(self, callback: F) -> Self
where F: Fn(()) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Called when Client::connect opens the session.

Source

pub fn on_packet<F, Fut>(self, callback: F) -> Self
where F: Fn(Packet) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Called with every received packet.

Source

pub async fn build(self) -> Result<Client>

Polling handshake, then a websocket upgrade when the server offers one; when the upgrade fails (a proxy that drops Upgrade:), the session stays on polling, like engine.io-client.

Source

pub async fn build_polling(self) -> Result<Client>

Polling only.

Source

pub async fn build_websocket_with_upgrade(self) -> Result<Client>

Polling handshake, then the websocket upgrade; fails when the server offers none.

Source

pub async fn build_websocket(self) -> Result<Client>

Websocket only: the handshake runs over the websocket, or (after a polling handshake) the upgrade probe does. Bounded by the timeout: a blackholed websocket (a proxy that accepts TCP and drops the upgrade) would otherwise hang and build_with_fallback would never fall back to polling.

Source

pub async fn build_with_fallback(self) -> Result<Client>

Polling handshake, then the websocket upgrade within half the timeout; when the upgrade fails (blocked or blackholed websocket) the session stays on polling with the same sid, as engine.io-client does after a failed probe.

Trait Implementations§

Source§

impl Clone for ClientBuilder

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 ClientBuilder

Source§

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

Formats the value using the given formatter. Read more

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