Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MessageQueue

A message queue is used to pass Message between different servers and components.

The Message queue is a key component for the clustering of collaboration servers. All collaboration servers in the cluster communicate by passing messages through the message queue.

A message queue can be implemented on top of RabbitMQ, Kafka, Redis, etc.

Hierarchy

  • MessageQueue

Index

Methods

Methods

publish

  • publish(msg: Message): Promise<boolean>

  • Publish message to the message queue.

    Parameters

    • msg: Message

      the message will be published.

    Returns Promise<boolean>

    • true means success.
    • false means failure.

subscribe

  • subscribe(handler: ((msg: Message) => any)): any

  • Subscribe to the message queue.

    Parameters

    • handler: ((msg: Message) => any)

      message handlers to process messages received from message queue.

    Returns any

Generated using TypeDoc