Options
All
  • Public
  • Public/Protected
  • All
Menu

Handles the processing order of incoming Matrix events.

Events can be pushed to the queue and will be processed when their corresponding data is ready and they are at the head of line. Different types of queues can be chosen for the processing order of events.

Abstract Base Class. Use the factory method create to create new instances.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new EventQueue(type: "none" | "single" | "per_room", consumeFn: ConsumeCallback): EventQueue

Properties

Protected consumeFn

consumeFn: ConsumeCallback

Methods

consume

  • consume(): void

push

  • push(event: { room_id: string }, dataReady: DataReady): void
  • 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

Generated using TypeDoc