Struct Socket 

pub struct Socket { /* private fields */ }

Handle used to configure channels and control the managed connection.

The companion Driver owns all protocol and transport state and must be polled continuously.

Implementations

impl Socket

pub fn new( connector: impl Connector + 'static, timer: impl Timer + 'static, options: Options, ) -> (Self, Driver)

Creates a socket and driver using the bounded default Phoenix v2 codec.

pub fn new_with_codec( connector: impl Connector + 'static, timer: impl Timer + 'static, options: Options, codec: impl Codec + 'static, ) -> (Self, Driver)

Creates a socket and driver using an application-provided codec.

pub fn channel( &self, topic: impl Into<String>, payload_loader: JoinPayloadLoader, ) -> Result<Channel, ClientError>

Registers one channel topic and its per-attempt join payload loader.

Only one live Channel handle may exist for a topic.

pub fn events(&self) -> Result<SocketEvents, ClientError>

Creates an independent bounded socket event subscriber.

pub fn status(&self) -> SocketStatus

Returns the latest socket status.

pub fn status_changes(&self) -> SocketStatusChanges

Creates a stream of subsequent socket status changes.

pub async fn connect(&self) -> Result<(), ClientError>

Enables connection attempts and waits until the command is accepted.

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

Disables automatic reconnection and closes the active transport.

pub async fn disconnect_with( &self, code: u16, reason: impl Into<String>, ) -> Result<(), ClientError>

Disconnects with an explicit WebSocket close code and reason.

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

Disconnects and immediately enables a new connection cycle.

pub async fn ping(&self) -> Result<Duration, ClientError>

Sends a heartbeat using the default call timeout and returns its RTT.

pub async fn ping_with_timeout( &self, timeout: Duration, ) -> Result<Duration, ClientError>

Sends a heartbeat with an explicit timeout and returns its RTT.

pub async fn shutdown(&self) -> Result<(), ClientError>

Permanently stops the driver and closes the active transport.

Trait Implementations

impl Clone for Socket

fn clone(&self) -> Socket

Returns a duplicate of the value.

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

Performs copy-assignment from source.