EventQueueAsyncExtensions

Asynchronous extensions for IEventQueue.

Static Methods

WaitEventAsync

Gets or waits for a new event from the queue. Waiting can be canceled by EmitBreakEventAsync.

Params

eventQueue

this IEventQueue

token

CancellationToken

static ValueTask<Event> WaitEventAsync(
this IEventQueue eventQueue,
CancellationToken token = default
)

Returns

ValueTask<Event> · A new event.

GetEvent

Gets a new event from the queue.

Params

eventQueue

this IEventQueue

token

CancellationToken

static ValueTask<Event?> GetEvent(
this IEventQueue eventQueue,
CancellationToken token = default
)

Returns

ValueTask<Event?> · A new event, or null if no events in the queue.

EmitBreakEventAsync

Puts the LibBreakEvent event into the event queue. This method is useful for interrupting a blocking WaitEventAsync call and breaking an event processing loop.

Params

eventQueue

this IEventQueue

token

CancellationToken

static ValueTask EmitBreakEventAsync(
this IEventQueue eventQueue,
CancellationToken token = default
)

Returns

ValueTask ·