IPWorks IoT 2020 Node.js Edition

Questions / Feedback?

IncomingMessageDeliveryMode Property

The delivery mode of the message.

Syntax

 amqpclassic.getIncomingMessageDeliveryMode(index, [callback])

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getIncomingMessageDeliveryMode([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setIncomingMessageDeliveryMode([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The delivery mode of the message.

This property holds the delivery mode of the message; possible values are:

  • 0: Unspecified.
  • 1: Non-persistent; the message may be lost if the server encounters an error.
  • 2: Persistent; the message will not be lost, even in case of server errors.

The default is 0, which indicates that the message does not have an explicit delivery mode set.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.

This property is read-only and not available at design time.

Data Type

Integer

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks IoT 2020 Node.js Edition - Version 20.0 [Build 8265]