Struct ControlHandle

pub struct ControlHandle<N>
where
    N: Notify,
{ /* private fields */ }

A control handle that can control the event queue.

Implementations

impl<N> ControlHandle<N>

where N: Notify,

pub async fn add_client(&mut self, notifier: N) -> Result<(), EventQueueDropped>

Add a new client to the event queue. If there were events queued before, the new client will receive the last event.

pub async fn clear(&mut self) -> Result<(), EventQueueDropped>

Make all existing clients in the event queue stop adding new events to their queue, and once they receive all queued events, they will be dropped.

pub async fn queue_event( &mut self, event: N::Event, ) -> Result<(), EventQueueDropped>

Queue an event that will be sent to all clients.

pub async fn try_flush( &mut self, timeout: Duration, ) -> Result<impl Future<Output = Result<(), TimedOut>>, EventQueueDropped>

Try to flush all pending events to all connected clients, returning a future that completes once all events are flushed or the given timeout duration is reached.

pub async fn ping(&mut self) -> Result<(), EventQueueDropped>

Pings the event queue. When this returns, you can be sure that all previous actions via this control handle have been processed (but not necessarily forwarded to all clients yet).

Trait Implementations

impl<N> Clone for ControlHandle<N>

where N: Notify,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N> Debug for ControlHandle<N>

where N: Notify,

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

Formats the value using the given formatter.