Class EventQueueSingle

EventQueue for which all events are enqueued in their order of arrival.

The foremost event is processed as soon as its data is available.

Hierarchy

EventQueue
- EventQueueSingle

Index

Constructors

constructor

Properties

consumeFn

Methods

Constructors

constructor

new EventQueueSingle(consumeFn: ConsumeCallback): EventQueueSingle

Overrides EventQueue.constructor
- Defined in src/components/event-queue.ts:127
Parameters
- consumeFn: ConsumeCallback
Returns EventQueueSingle

Properties

Protected consumeFn

consumeFn: ConsumeCallback

Methods

consume

consume(): void

Inherited from EventQueue.consume
- Defined in src/components/event-queue.ts:76
Starts consuming the queue.

As long as events are enqueued they will continue to be consumed.

Returns void

push

push(event: { room_id: string }, dataReady: DataReady): void

Inherited from EventQueue.push
- Defined in src/components/event-queue.ts:52
Push the event and its related data to the queue.

Parameters
- event: { room_id: string }
  
  The event to enqueue.
  - room_id: string
- dataReady: DataReady
  
  Promise containing data related to the event.
Returns void

Static create

create(opts: { type: "none" | "single" | "per_room" }, consumeFn: ConsumeCallback): EventQueueSingle | EventQueuePerRoom | EventQueueNone

Inherited from EventQueue.create
- Defined in src/components/event-queue.ts:105
Factory for EventQueues.

Parameters
- opts: { type: "none" | "single" | "per_room" }
  - type: "none" | "single" | "per_room"
    
    Type of the queue to create.
- consumeFn: ConsumeCallback
  
  Function which is called when an event is consumed.
Returns EventQueueSingle | EventQueuePerRoom | EventQueueNone

The newly created EventQueue.

Generated using TypeDoc