Struct BroadcastDynamic 

pub struct BroadcastDynamic { /* private fields */ }

Handles on-demand track creation for a broadcast.

When a consumer requests a track that doesn’t exist, a TrackProducer is created and queued for the dynamic producer to fulfill via Self::requested_track. Dropped when no longer needed; pending requests are automatically aborted.

Implementations

impl BroadcastDynamic

pub fn poll_requested_track( &mut self, waiter: &Waiter, ) -> Poll<Result<TrackProducer, Error>>

Poll for the next consumer-requested track, without blocking. The returned producer is preconfigured with the requested track’s name and priority.

pub async fn requested_track(&mut self) -> Result<TrackProducer, Error>

Block until a consumer requests a track, returning its producer.

pub fn consume(&self) -> BroadcastConsumer

Create a consumer that can subscribe to tracks in this broadcast.

pub async fn closed(&self) -> Error

Block until the broadcast is closed or aborted, returning the cause.

pub fn abort(&mut self, err: Error) -> Result<(), Error>

Abort the broadcast with the given error.

Externally-owned tracks are independent and must be aborted separately; inserted tracks are referenced via weak handles. Pending dynamic track requests are owned by the broadcast and aborted here so consumers don’t stay stuck waiting on producers nobody will fulfill.

pub fn is_clone(&self, other: &BroadcastDynamic) -> bool

Return true if this is the same broadcast instance.

Trait Implementations

impl Clone for BroadcastDynamic

fn clone(&self) -> BroadcastDynamic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Deref for BroadcastDynamic

type Target = Broadcast

The resulting type after dereferencing.

fn deref(&self) -> &<BroadcastDynamic as Deref>::Target

Dereferences the value.

impl Drop for BroadcastDynamic

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.