IncomingMessageMessageExpInterval Property
The lifetime of the message in seconds specified by the sender.
Syntax
mqtt.getIncomingMessageMessageExpInterval(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 getIncomingMessageMessageExpInterval([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 setIncomingMessageMessageExpInterval([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 lifetime of the message in seconds specified by the sender.
For outgoing messages, the value is useful for instructing the server to delete its copies of the message for any subscribers it has not been able to start delivery to.
For incoming messages, the value sent by the server is the lifetime specified by the sender minus the time the message has been waiting in the server.
Valid only for MQTT 5.
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