Struct Broadcaster 

pub struct Broadcaster { /* private fields */ }

The broadcaster manages channels and client connections.

Implementations

impl Broadcaster

pub fn new() -> Broadcaster

Create a new broadcaster with default configuration.

pub fn with_config(config: BroadcastConfig) -> Broadcaster

Create a new broadcaster with the given configuration.

pub fn with_authorizer<A>(self, authorizer: A) -> Broadcaster

where A: ChannelAuthorizer + 'static,

Set the channel authorizer.

pub fn config(&self) -> &BroadcastConfig

Get the configuration.

pub fn add_client(&self, socket_id: String, sender: Sender<ServerMessage>)

Register a new client connection.

pub fn remove_client(&self, socket_id: &str)

Remove a client and clean up their subscriptions.

pub async fn subscribe( &self, socket_id: &str, channel_name: &str, auth: Option<&str>, member_info: Option<PresenceMember>, ) -> Result<(), Error>

Subscribe a client to a channel.

pub async fn unsubscribe(&self, socket_id: &str, channel_name: &str)

Unsubscribe a client from a channel.

pub async fn broadcast<T>( &self, channel: &str, event: &str, data: T, ) -> Result<(), Error>

where T: Serialize,

Broadcast a message to a channel.

pub async fn whisper( &self, socket_id: &str, channel_name: &str, event: &str, data: Value, ) -> Result<(), Error>

Forward a client event (whisper) to other subscribers of the same channel.

Used for client-to-client messaging such as typing indicators and cursor positions. Only works when allow_client_events is enabled in configuration. The sender is excluded from receiving the whispered message.

pub async fn broadcast_except<T>( &self, channel: &str, event: &str, data: T, except_socket_id: &str, ) -> Result<(), Error>

where T: Serialize,

Broadcast to a channel, excluding a specific client.

pub async fn check_auth(&self, auth_data: &AuthData) -> bool

Check if a client would be authorized for a channel.

Returns true if:

• Channel is public (no auth needed)
• Channel is private/presence AND authorizer returns true

Returns false if:

• Channel is private/presence AND no authorizer registered
• Channel is private/presence AND authorizer denies access

Used by the broadcasting auth HTTP endpoint to validate authorization without subscribing the client.

pub fn get_channel(&self, name: &str) -> Option<ChannelInfo>

Get channel info.

pub fn client_count(&self) -> usize

Get number of connected clients.

pub fn channel_count(&self) -> usize

Get number of active channels.

Trait Implementations

impl Clone for Broadcaster

fn clone(&self) -> Broadcaster

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Broadcaster

fn default() -> Broadcaster

Returns the “default value” for a type.