Struct BroadcastManager 

pub struct BroadcastManager { /* private fields */ }

Manages direct user messaging via WebSocket

Implementations

impl BroadcastManager

pub fn new() -> Self

Create a new manager with default config

pub fn with_config(config: BroadcastConfig) -> Self

Create with custom config

pub async fn register_user( &self, tn_id: TnId, id_tag: &str, connection_id: &str, ) -> Receiver<BroadcastMessage>

Register a user connection for direct messaging

Returns a receiver for messages targeted at this user. The connection_id should be a unique identifier (UUID) for this specific connection, allowing multiple connections per user (multiple tabs/devices).

pub async fn unregister_user( &self, tn_id: TnId, id_tag: &str, connection_id: &str, )

Unregister a user connection

Removes the specific connection identified by connection_id. Other connections for the same user (other tabs) are preserved.

pub async fn send_to_user( &self, tn_id: TnId, id_tag: &str, msg: BroadcastMessage, ) -> DeliveryResult

Send a message to a specific user

Delivers the message to all connections for the user (multiple tabs/devices). Returns DeliveryResult::Delivered(n) with the number of connections that received the message, or DeliveryResult::UserOffline if the user has no active connections.

pub async fn send_to_tenant(&self, tn_id: TnId, msg: BroadcastMessage) -> usize

Send a message to all users in a tenant

Broadcasts the message to all connections for all users in the tenant. Returns the total number of connections that received the message.

pub async fn is_user_online(&self, tn_id: TnId, id_tag: &str) -> bool

Check if a user is currently online (has at least one connection)

pub async fn online_users(&self, tn_id: TnId) -> Vec<Box<str>>

Get list of all online users for a tenant

pub async fn user_stats(&self) -> UserRegistryStats

Get user registry statistics

pub async fn cleanup_users(&self)

Cleanup disconnected users (users with no active receivers)

Trait Implementations

impl Default for BroadcastManager

fn default() -> Self

Returns the “default value” for a type.