Struct thruster_socketio::SocketIO

pub struct SocketIO { /* fields omitted */ }

Implementations

impl SocketIOSocket

pub fn new(
    id: String,
    sender: Sender<InternalMessage>,
    receiver: Receiver<InternalMessage>
) -> Self

pub fn id(&self) -> &str

id returns the id for this particular socket.

pub fn use_handler(
    &self,
    _handler: fn(_: SocketIOSocket, _: String) -> Pin<Box<dyn Future<Output = Result<(), ()>> + Send>>
)

use_handler isn't implemented yet.

pub fn on(
    &mut self,
    event: &str,
    handler: fn(_: SocketIOSocket, _: String) -> Pin<Box<dyn Future<Output = Result<(), ()>> + Send>>
)

on adds a listener for a particular event

pub async fn join<'_, '_>(&'_ mut self, room_id: &'_ str)

join joins a socket into a room. This makes every message sent by that socket go to the room rather than globally.

pub async fn leave<'_, '_>(&'_ mut self, room_id: &'_ str)

leave removes a socket from a room. Note that you cannot remove a socket from its default room, i.e. its SID. This will result in a noop.

pub async fn send<'_, '_, '_>(&'_ self, event: &'_ str, message: &'_ str)

send sends a message to this socket

pub async fn emit_to<'_, '_, '_, '_>(
    &'_ self,
    room_id: &'_ str,
    event: &'_ str,
    message: &'_ str
)

emit_to sends a message to all sockets connected to the given room_id, including the sending socket.

pub async fn broadcast_to<'_, '_, '_, '_>(
    &'_ self,
    room_id: &'_ str,
    event: &'_ str,
    message: &'_ str
)

broadcast_to sends a message to all the sockets connected to the given room_id, excluding the sending socket.

pub fn rooms(&self) -> &Vec<String>

rooms returns all of the rooms this socket is currently in

Trait Implementations

impl Clone for SocketIOSocket

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.