Class: AmqpQueue

AmqpQueue()

new AmqpQueue()

Manages an AMQP queue.
Source:
Fires:

Methods

(async) ack(msg) → {Promise.<void>}

Use this if the message is processed successfully.
Parameters:
Name Type Description
msg AmqpMessage
Source:
Throws:
Returns:
Type
Promise.<void>

(async) close() → {Promise.<void>}

To close the queue. You can use `await` to get the result or listen events.
Source:
Throws:
SdkError
Returns:
Type
Promise.<void>

connect()

To connect to the message queue. The `AmqpQueue` will report status with Status.
Source:
Throws:
Wrong usage.
Type
Error

isRecv() → {boolean}

Is the queue a receiver.
Source:
Returns:
Type
boolean

(async) nack(msg) → {Promise.<void>}

To requeue the message and the broker will send the message in the future.
Parameters:
Name Type Description
msg AmqpMessage
Source:
Throws:
Returns:
Type
Promise.<void>

name() → {string}

To get the queue name.
Source:
Returns:
Type
string

(async) sendMsg(payload) → {Promise.<void>}

To send a message (for senders only).
Parameters:
Name Type Description
payload Buffer The raw data to be sent.
Source:
Throws:
Returns:
Type
Promise.<void>

setMsgHandler(handlernullable)

Set the message handler.
Parameters:
Name Type Attributes Description
handler AmqpQueueMsgHandler <nullable>
Source:
Throws:
Wrong arguments.
Type
Error

status() → {Status}

To get the queue status.
Source:
Returns:
Type
Status

Events

error

Queue error event.
Type:
  • Error
Source:

status

Queue status event.
Type:
Source:

AmqpQueue(opts, conn)

new AmqpQueue(opts, conn)

Parameters:
Name Type Description
opts Object The queue options.
Properties
Name Type Attributes Default Description
name string The queue name that is used to map a AMQP queue (unicast) or an exchange (broadcast). The pattern is `^[a-z0-9_-]+([\.]{1}[a-z0-9_-]+)*$`.
isRecv boolean `true` for the receiver and `false` for the sender.
reliable boolean Reliable by selecting the confirm channel (for publish).
broadcast boolean `true` for broadcast and `false` for unicast.
reconnectMillis number <optional>
 1000 Time in milliseconds from disconnection to reconnection.
prefetch number <optional>
 REQUIRED when `isRecv=true`. The QoS of the receiver queue. This value MUST be a positive value between 1 to 65535.
persistent boolean <optional>
 false Use persistent delivery mode.
conn AmqpConnection The AMQP connection.
Source:
Throws:
Wrong arguments.
Type
Error

Methods

(async) ack(msg) → {Promise.<void>}

Use this if the message is processed successfully.
Parameters:
Name Type Description
msg AmqpMessage
Source:
Throws:
Returns:
Type
Promise.<void>

(async) close() → {Promise.<void>}

To close the queue. You can use `await` to get the result or listen events.
Source:
Throws:
SdkError
Returns:
Type
Promise.<void>

connect()

To connect to the message queue. The `AmqpQueue` will report status with Status.
Source:
Throws:
Wrong usage.
Type
Error

isRecv() → {boolean}

Is the queue a receiver.
Source:
Returns:
Type
boolean

(async) nack(msg) → {Promise.<void>}

To requeue the message and the broker will send the message in the future.
Parameters:
Name Type Description
msg AmqpMessage
Source:
Throws:
Returns:
Type
Promise.<void>

name() → {string}

To get the queue name.
Source:
Returns:
Type
string

(async) sendMsg(payload) → {Promise.<void>}

To send a message (for senders only).
Parameters:
Name Type Description
payload Buffer The raw data to be sent.
Source:
Throws:
Returns:
Type
Promise.<void>

setMsgHandler(handlernullable)

Set the message handler.
Parameters:
Name Type Attributes Description
handler AmqpQueueMsgHandler <nullable>
Source:
Throws:
Wrong arguments.
Type
Error

status() → {Status}

To get the queue status.
Source:
Returns:
Type
Status

Events

error

Queue error event.
Type:
  • Error
Source:

status

Queue status event.
Type:
Source: