Skip to main content

BroadcastConfig

Struct BroadcastConfig 

Source
pub struct BroadcastConfig {
    pub max_subscribers_per_channel: usize,
    pub max_channels: usize,
    pub heartbeat_interval: Duration,
    pub client_timeout: Duration,
    pub allow_client_events: bool,
}
Expand description

Configuration for the broadcaster.

Fields§

§max_subscribers_per_channel: usize

Maximum subscribers per channel (0 = unlimited).

§max_channels: usize

Maximum channels (0 = unlimited).

§heartbeat_interval: Duration

Heartbeat interval for WebSocket connections.

§client_timeout: Duration

Client timeout (disconnect if no activity).

§allow_client_events: bool

Whether to allow client-to-client messages (whisper).

Implementations§

Source§

impl BroadcastConfig

Source

pub fn new() -> Self

Create a new broadcast config with defaults.

Source

pub fn from_env() -> Self

Create configuration from environment variables.

Reads the following environment variables:

  • BROADCAST_MAX_SUBSCRIBERS: Max subscribers per channel (default: unlimited)
  • BROADCAST_MAX_CHANNELS: Max total channels (default: unlimited)
  • BROADCAST_HEARTBEAT_INTERVAL: Heartbeat interval in seconds (default: 30)
  • BROADCAST_CLIENT_TIMEOUT: Client timeout in seconds (default: 60)
  • BROADCAST_ALLOW_CLIENT_EVENTS: Allow whisper messages (default: true)
§Example
use ferro_broadcast::BroadcastConfig;

let config = BroadcastConfig::from_env();
let broadcaster = Broadcaster::with_config(config);
Source

pub fn max_subscribers_per_channel(self, max: usize) -> Self

Set maximum subscribers per channel.

Source

pub fn max_channels(self, max: usize) -> Self

Set maximum channels.

Source

pub fn heartbeat_interval(self, interval: Duration) -> Self

Set heartbeat interval.

Source

pub fn client_timeout(self, timeout: Duration) -> Self

Set client timeout.

Source

pub fn allow_client_events(self, allow: bool) -> Self

Set whether client events (whisper) are allowed.

Trait Implementations§

Source§

impl Clone for BroadcastConfig

Source§

fn clone(&self) -> BroadcastConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BroadcastConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BroadcastConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more