Struct SocketControl 

pub struct SocketControl { /* private fields */ }

State publisher and reconnect registration for one logical socket endpoint.

A clone starts without ownership of the source control’s active transport generation.

Implementations

impl SocketControl

pub fn new( client_id: ClientId, venue: Option<Venue>, endpoint: impl AsRef<str>, ) -> Self

Creates a new SocketControl instance.

pub fn with_registry( client_id: ClientId, venue: Option<Venue>, endpoint: impl AsRef<str>, registry: &SocketReconnectRegistry, ) -> Self

Creates a control which registers with an explicit live socket registry.

pub fn sink(&self) -> SocketStateSink

Returns a sink which publishes transport state changes as system events.

pub fn sink_with<F>(&self, on_state: F) -> SocketStateSink

where F: Fn(SocketState) + Send + Sync + 'static,

Returns a state sink which calls on_state before publishing each change.

on_state must not synchronously trigger another state change for the same endpoint.

pub fn register<F>(&self, request: F)

where F: Fn() -> ReconnectRequestOutcome + Send + Sync + 'static,

Registers a reconnect request function for this endpoint’s active generation.

pub fn deregister(&self)

Removes the reconnect handle owned by this control generation.

Trait Implementations

impl Clone for SocketControl

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SocketControl

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

Formats the value using the given formatter.

impl Drop for SocketControl

fn drop(&mut self)

Executes the destructor for this type.

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.