Struct RemoteSocket 

pub struct RemoteSocket<A> { /* private fields */ }

A RemoteSocket is a Socket that is remotely connected on another server. It implements a subset of the Socket API.

Implementations

impl<A> RemoteSocket<A>

pub fn into_data(self) -> RemoteSocketData

Consume the RemoteSocket and return its underlying data

pub fn data(&self) -> &RemoteSocketData

Get a ref to the underlying data of the socket

impl<A: Adapter> RemoteSocket<A>

pub async fn emit<T: ?Sized + Serialize>( &self, event: impl AsRef<str>, data: &T, ) -> Result<(), RemoteActionError>

Emit a message to a client that is remotely connected on another server.

See Socket::emit for more info.

pub async fn emit_with_ack<T: ?Sized + Serialize, V: DeserializeOwned>( &self, event: impl AsRef<str>, data: &T, ) -> Result<AckStream<V, A>, RemoteActionError>

Emit a message to a client that is remotely connected on another server and wait for an acknowledgement.

See Socket::emit_with_ack for more info.

pub async fn rooms(&self) -> Result<Vec<Room>, A::Error>

Get all room names this remote socket is connected to.

See Socket::rooms for more info.

pub fn join( &self, rooms: impl RoomParam, ) -> impl Future<Output = Result<(), A::Error>> + '_

Add the remote socket to the specified room(s).

See Socket::join for more info.

pub fn leave( &self, rooms: impl RoomParam, ) -> impl Future<Output = Result<(), A::Error>> + Send + '_

Remove the remote socket from the specified room(s).

See Socket::leave for more info.

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

Disconnect the remote socket from the current namespace,

See Socket::disconnect for more info.

Trait Implementations

impl<A> Clone for RemoteSocket<A>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A> Debug for RemoteSocket<A>

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

Formats the value using the given formatter.