Struct BroadcastHub 

pub struct BroadcastHub<T>
where
    T: Clone + Serialize + Send + Sync + 'static,
{ /* private fields */ }

A typed broadcast hub for WebSocket messages.

T must be Clone (required by tokio::sync::broadcast) and Serialize so that it can be encoded via crate::codec::Codec.

The hub is cheap to clone — all clones share the same underlying channel and connection counter.

Example

use ws_kit::hub::BroadcastHub;
use serde::{Serialize, Deserialize};

#[derive(Clone, Serialize, Deserialize, Debug, PartialEq)]
struct Msg { text: String }

let hub = BroadcastHub::<Msg>::new(16);
let mut rx = hub.subscribe();
hub.broadcast(Msg { text: "hello".into() }).unwrap();
assert_eq!(rx.recv().await.unwrap().text, "hello");

Implementations

impl<T> BroadcastHub<T>

where T: Clone + Serialize + Send + Sync + 'static,

pub fn new(capacity: usize) -> Self

Create a new hub with the given broadcast capacity.

pub fn from_config(config: &WsConfig) -> Self

Create a hub from crate::config::WsConfig.

pub fn subscribe(&self) -> Receiver<T>

Subscribe to the broadcast channel.

pub fn broadcast(&self, msg: T) -> Result<usize, WsError>

Broadcast a message to all subscribers.

Returns the number of receivers that received the message.

Errors

Returns WsError::BroadcastFull if there are no active receivers. tokio::sync::broadcast does not have a full error — the buffer is a ring — but to preserve the WsError::BroadcastFull contract we surface it when send fails due to lack of receivers or lag.

pub fn try_broadcast(&self, msg: T) -> usize

Try to broadcast, returning Ok(0) when there are no receivers instead of an error. Useful for fire-and-forget.

pub fn connection_count(&self) -> u64

Current number of tracked connections.

pub fn increment_connections(&self, max: Option<usize>) -> Result<u64, WsError>

Atomically increment the connection counter.

Returns the new count. If max is Some, returns WsError::TooManyConnections when the limit would be exceeded and does not increment.

pub fn decrement_connections(&self) -> u64

Atomically decrement the connection counter (saturating).

pub fn receiver_count(&self) -> usize

Number of active receivers.

pub fn capacity(&self) -> usize

Channel capacity.

pub fn sender(&self) -> &Sender<T>

Internal sender handle (for advanced use).

impl<T> BroadcastHub<T>

where T: Clone + Serialize + Send + Sync + 'static,

pub fn with_capacity(capacity: usize) -> Self

Create hub with explicit capacity tracking (internal).

Trait Implementations

impl<T> Clone for BroadcastHub<T>

where T: Clone + Serialize + Send + Sync + 'static,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for BroadcastHub<T>

where T: Clone + Serialize + Send + Sync + 'static,

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

Formats the value using the given formatter.