JSDoc: Class: MqttQueue

new MqttQueue()

Manages an MQTT queue.

Source:

mqtt-queue.js, line 39

Fires:

Methods

ack(msg, callback)

Use this if the message is processed successfully.

Parameters:

Name Type Description

msg MqttMessage

callback

function

Properties

Name	Type	Attributes	Description
`err`	Error	<nullable>

Source:

mqtt-queue.js, line 256

close(callbackopt)

To close the queue. You can use a callback function to get the result or listen events.

Parameters:

Name Type Attributes Description

callback

function

Properties

Name	Type	Attributes	Description
`err`	Error	<nullable>

Source:

mqtt-queue.js, line 180

connect()

To connect to the message queue. The `MqttQueue` will report status with Status.

Source:

mqtt-queue.js, line 151

Throws:

Wrong usage.
Type Error

isRecv() → {boolean}

Is the queue a receiver.

Source:

mqtt-queue.js, line 119

Returns:

Type: boolean

nack(msg, callback)

To requeue the message and the broker will send the message in the future.

Parameters:

Name Type Description

msg MqttMessage

callback

function

Properties

Name	Type	Attributes	Description
`err`	Error	<nullable>

Source:

mqtt-queue.js, line 275

name() → {string}

To get the queue name.

Source:

mqtt-queue.js, line 110

Returns:

Type: string

sendMsg(payload, callback)

To send a message (for senders only).

Parameters:

Name Type Description

payload Buffer The raw data to be sent.

callback

function

Properties

Name	Type	Attributes	Description
`err`	Error	<nullable>

Source:

mqtt-queue.js, line 224

Throws:

Wrong arguments.
Type Error

setMsgHandler(handlernullable)

Set the message handler.

Parameters:

Name	Type	Attributes	Description
`handler`	MqttQueueMsgHandler	<nullable>

Source:

mqtt-queue.js, line 138

Throws:

Wrong arguments.
Type Error

status() → {Status}

To get the queue status.

Source:

mqtt-queue.js, line 128

Returns:

Type: Status

Events

error

Queue error event.

Type:

Error

Source:

mqtt-queue.js, line 10

status

Queue status event.

Type:

Status

Source:

mqtt-queue.js, line 17

new MqttQueue(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 MQTT 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.
`sharedPrefix`	string	<optional>		OPTIONAL when `isRecv=true`. This is used for unicast.

conn MqttConnection The MQTT connection.

Source:

mqtt-queue.js, line 61

Throws:

Wrong arguments.
Type Error

Methods

ack(msg, callback)

Use this if the message is processed successfully.

Parameters:

Name Type Description

msg MqttMessage

callback

function

Properties

Name	Type	Attributes	Description
`err`	Error	<nullable>

Source:

mqtt-queue.js, line 256

close(callbackopt)

To close the queue. You can use a callback function to get the result or listen events.

Parameters:

Name Type Attributes Description

callback

function

Properties

Name	Type	Attributes	Description
`err`	Error	<nullable>

Source:

mqtt-queue.js, line 180

connect()

To connect to the message queue. The `MqttQueue` will report status with Status.

Source:

mqtt-queue.js, line 151

Throws:

Wrong usage.
Type Error

isRecv() → {boolean}

Is the queue a receiver.

Source:

mqtt-queue.js, line 119

Returns:

Type: boolean

nack(msg, callback)

To requeue the message and the broker will send the message in the future.

Parameters:

Name Type Description

msg MqttMessage

callback

function

Properties

Name	Type	Attributes	Description
`err`	Error	<nullable>

Source:

mqtt-queue.js, line 275

name() → {string}

To get the queue name.

Source:

mqtt-queue.js, line 110

Returns:

Type: string

sendMsg(payload, callback)

To send a message (for senders only).

Parameters:

Name Type Description

payload Buffer The raw data to be sent.

callback

function

Properties

Name	Type	Attributes	Description
`err`	Error	<nullable>

Source:

mqtt-queue.js, line 224

Throws:

Wrong arguments.
Type Error

setMsgHandler(handlernullable)

Set the message handler.

Parameters:

Name	Type	Attributes	Description
`handler`	MqttQueueMsgHandler	<nullable>

Source:

mqtt-queue.js, line 138

Throws:

Wrong arguments.
Type Error

status() → {Status}

To get the queue status.

Source:

mqtt-queue.js, line 128

Returns:

Type: Status

Events

error

Queue error event.

Type:

Error

Source:

mqtt-queue.js, line 10

status

Queue status event.

Type:

Status

Source:

mqtt-queue.js, line 17