Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IMessageQueueConnection

Defines an interface for message queue connections

Hierarchy

  • IMessageQueueConnection

Index

Methods

createQueue

  • createQueue(name: string, callback: function): void
  • Creates a message queue. If connection doesn't support this function it exists without error.

    Parameters

    • name: string

      the name of the queue to be created.

    • callback: function

      notifies about completion with error or null for success.

        • (err: any): void
        • Parameters

          • err: any

          Returns void

    Returns void

deleteQueue

  • deleteQueue(name: string, callback: function): void
  • Deletes a message queue. If connection doesn't support this function it exists without error.

    Parameters

    • name: string

      the name of the queue to be deleted.

    • callback: function

      notifies about completion with error or null for success.

        • (err: any): void
        • Parameters

          • err: any

          Returns void

    Returns void

readQueueNames

  • readQueueNames(callback: function): void
  • Reads a list of registered queue names. If connection doesn't support this function returnes an empty list.

    callback

    to receive a list with registered queue names or an error.

    Parameters

    • callback: function
        • (err: any, names: string[]): void
        • Parameters

          • err: any
          • names: string[]

          Returns void

    Returns void

Generated using TypeDoc