Options
All
  • Public
  • Public/Protected
  • All
Menu

MessageBroker encapsulates transactions with message brokering middleware.

Hierarchy

  • MessageBroker

Implemented by

Index

Methods

disconnect

  • disconnect(): Promise<void>
  • If possible, quickly disconnects from the broker. Call only once.

    Returns Promise<void>

    A Promise that resolves when the broker is disconnected.

end

  • end(): Promise<void>
  • Gently disconnects from the broker. Should only be called once.

    Returns Promise<void>

    A Promise that resolves when the broker is disconnected.

publish

  • Publishes a message onto the broker.

    Parameters

    • message: TaskMessage

      The message to be published. Used to infer transport options.

    Returns Promise<string>

    A Promise that resolves to the response of the broker after the operation is completed.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc