Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AmqpClient

AMQP Client entry point. Use this interface to create an instance of AmqpClient and connect to a broker and server.

Hierarchy

  • AmqpClient

Index

Methods

Methods

close

  • close(): PromiseLike<void> | null
  • close(closeHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>> | null | undefined): void

  • Closes the client. The client must always be closed once not needed anymore.

    Returns PromiseLike<void> | null

  • Closes the client. The client must always be closed once not needed anymore.

    Parameters

    • closeHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>> | null | undefined

    Returns void

connect

  • Connects to the AMQP broker or router. The location is specified in the AmqpClientOptions as well as the potential credential required.

    Returns PromiseLike<AmqpConnection>

  • Connects to the AMQP broker or router. The location is specified in the AmqpClientOptions as well as the potential credential required.

    Parameters

    Returns AmqpClient

createReceiver

  • Creates a receiver used to consume messages from the given address. The receiver has no handler and won't start receiving messages until a handler is explicitly configured. This method avoids having to connect explicitly. You can retrieve the connection using {@link AmqpReceiver#connection}.

    Parameters

    • address: string

    Returns PromiseLike<AmqpReceiver>

  • Creates a receiver used to consume messages from the given address. The receiver has no handler and won't start receiving messages until a handler is explicitly configured. This method avoids having to connect explicitly. You can retrieve the connection using {@link AmqpReceiver#connection}.

    Parameters

    Returns AmqpClient

  • Creates a receiver used to consumer messages from the given address. This method avoids having to connect explicitly. You can retrieve the connection using {@link AmqpReceiver#connection}.

    Parameters

    Returns PromiseLike<AmqpReceiver>

  • Creates a receiver used to consumer messages from the given address. This method avoids having to connect explicitly. You can retrieve the connection using {@link AmqpReceiver#connection}.

    Parameters

    Returns AmqpClient

createSender

  • Creates a sender used to send messages to the given address. The address must be set.

    Parameters

    • address: string

    Returns PromiseLike<AmqpSender>

  • Creates a sender used to send messages to the given address. The address must be set.

    Parameters

    • address: string
    • completionHandler: ((res: AsyncResult<AmqpSender>) => void) | Handler<AsyncResult<AmqpSender>>

    Returns AmqpClient

  • Creates a sender used to send messages to the given address. The address must be set.

    Parameters

    Returns PromiseLike<AmqpSender>

  • Creates a sender used to send messages to the given address. The address must be set.

    Parameters

    Returns AmqpClient

Static create

  • Creates a new instance of AmqpClient using an internal Vert.x instance (with default configuration) and the given AMQP client configuration. Note that the created Vert.x instance will be closed when the client is closed.

    Parameters

    Returns AmqpClient

  • Creates a new instance of AmqpClient with the given Vert.x instance and the given options.

    Parameters

    Returns AmqpClient

Generated using TypeDoc