Skip to main content

SseBroadcaster

Struct SseBroadcaster 

Source
pub struct SseBroadcaster { /* private fields */ }
Expand description

Broadcasts Events to SSE clients via a tokio::sync::broadcast channel.

Register this as an EventSubscriber on the Engine to forward all (or filtered) domain events to connected SSE clients.

§Examples

use ironflow_api::sse::SseBroadcaster;

let broadcaster = SseBroadcaster::new();
assert_eq!(broadcaster.receiver_count(), 0);
let _receiver = broadcaster.subscribe();
assert_eq!(broadcaster.receiver_count(), 1);

Implementations§

Source§

impl SseBroadcaster

Source

pub fn new() -> Self

Create a new broadcaster with the default capacity (256).

§Examples
use ironflow_api::sse::SseBroadcaster;

let broadcaster = SseBroadcaster::new();
Source

pub fn with_capacity(capacity: usize) -> Self

Create a new broadcaster with a custom channel capacity.

§Examples
use ironflow_api::sse::SseBroadcaster;

let broadcaster = SseBroadcaster::with_capacity(64);
Source

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

Create a new receiver for the broadcast channel.

Each SSE client connection calls this to get its own receiver.

Source

pub fn receiver_count(&self) -> usize

Returns the number of active receivers (connected SSE clients).

Source

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

Returns a clone of the underlying sender.

Stored in AppState so that the SSE route can create receivers without holding a reference to the broadcaster.

Trait Implementations§

Source§

impl Default for SseBroadcaster

Source§

fn default() -> Self

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

impl EventSubscriber for SseBroadcaster

Source§

fn name(&self) -> &str

A short identifier for this subscriber (used in logs).
Source§

fn handle<'a>(&'a self, event: &'a Event) -> SubscriberFuture<'a>

Handle a domain event. 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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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