Struct IoEmitter

pub struct IoEmitter { /* private fields */ }

The IoEmitter is the main structure for emitting events to a socket.io cluster. It provides a convenient way to broadcast events to all connected nodes and clients. It acts as a simple builder for creating socket.io messages to send through the driver.

Implementations

impl IoEmitter

pub fn new() -> Self

Creates a new IoEmitter with the default settings.

pub fn new_msgpack() -> Self

Available on crate feature msgpack-parser only.

Creates a new IoEmitter with the msgpack parser.

pub fn of(self, ns: impl Into<Str>) -> IoEmitter

Sets the namespace for this IoEmitter. By default, the namespace is set to /.

pub fn to(self, rooms: impl RoomParam) -> IoEmitter

Sets the rooms for this IoEmitter. By default, events are sent to all rooms.

pub fn within(self, rooms: impl RoomParam) -> IoEmitter

Alias for IoEmitter::to.

pub fn except(self, rooms: impl RoomParam) -> IoEmitter

Excludes the specified rooms.

pub fn prefix(self, prefix: impl Into<String>) -> IoEmitter

You may have set a custom prefix on your adapter config, which will be used as a prefix for the channel name. By default, the prefix is socket.io.

impl IoEmitter

pub async fn join<D: Driver>( self, rooms: impl RoomParam, driver: &D, ) -> Result<(), D::Error>

Makes the selected sockets join the specified rooms.

Example

// Makes the sockets in the root namespace and in the room1 and room2, join the room4.
IoEmitter::new()
    .to(["room1", "room2"])
    .join("room4", &driver)
    .await?;

pub async fn leave<D: Driver>( self, rooms: impl RoomParam, driver: &D, ) -> Result<(), D::Error>

Makes the selected sockets leave the specified rooms.

Example

// Makes the sockets in the root namespace and in the room1 and room2, leave the room4.
IoEmitter::new()
    .to(["room1", "room2"])
    .leave("room4", &driver)
    .await?;

pub async fn disconnect<D: Driver>(self, driver: &D) -> Result<(), D::Error>

Disconnects the selected sockets from their namespace.

// Makes the sockets in the root namespace and in the room1 and room2, disconnect.
IoEmitter::new()
    .to(["room1", "room2"])
    .disconnect(&driver)
    .await?;

pub async fn emit<D: Driver, T: Serialize + ?Sized>( self, event: &str, msg: &T, driver: &D, ) -> Result<(), EmitError<D>>

Available on crate features msgpack-parser or common-parser only.

Emits a socket.io event to the selected sockets.

// Emits the event "message" with the message "Hello, world!" to the root namespace sockets
// that are in the room1 and room2
IoEmitter::new()
    .to(["room1", "room2"])
    .emit("message", "Hello, world!", &driver)
    .await?;

Trait Implementations

impl Clone for IoEmitter

fn clone(&self) -> IoEmitter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IoEmitter

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

Formats the value using the given formatter.

impl Default for IoEmitter

fn default() -> Self

Returns the “default value” for a type.