Struct runa_core::client::EventDispatcher

pub struct EventDispatcher<Ctx> { /* private fields */ }

A reference implementation of the event dispatcher

Implementations

impl<Ctx> EventDispatcher<Ctx>

pub fn new() -> Self

Create a new event dispatcher

impl<Ctx: Client + 'static> EventDispatcher<Ctx>

pub fn poll_next<'a>( &'a mut self, cx: &mut Context<'_> ) -> Poll<PendingEvent<'a, Ctx>>

Poll for the next event, which needs to be handled with the use of the client context.

Caveats

If this is called from multiple tasks, those tasks will just keep waking up each other and waste CPU cycles.

pub fn next(&mut self) -> impl FusedFuture<Output = PendingEvent<'_, Ctx>> + '_

Wait for the next event from the event dispatcher. Returns a future that resolves to a PendingEvent, the caller should call PendingEvent::handle to handle the event.

pub async fn handle_queued_events<'ctx>( &'ctx mut self, objects: &'ctx mut Ctx::ObjectStore, connection: &'ctx mut Ctx::Connection, server_context: &'ctx Ctx::ServerContext ) -> Result<(), Box<dyn Error + Send + Sync>>

Handle all events that are current queued. The futures returned will resolve as soon as there are no more events queued in this event dispatcher. It will not wait for new events to be queued, but it may wait for the futures returned by the event handlers to resolve.

Trait Implementations

impl<Ctx> Debug for EventDispatcher<Ctx>

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

Formats the value using the given formatter.

impl<Ctx> Default for EventDispatcher<Ctx>

fn default() -> Self

Returns the “default value” for a type.

impl<Ctx: Client + 'static> EventDispatcher<Ctx> for EventDispatcher<Ctx>

fn add_event_handler<M: Any>( &mut self, event_source: impl Stream<Item = M> + 'static, handler: impl EventHandler<Ctx, Message = M> + 'static )

Register an event handler