OutgoingMessageState Property
This message's current state.
Syntax
mqtt.getOutgoingMessageState(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 getOutgoingMessageState([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 setOutgoingMessageState([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
This message's current state.
Possible Outgoing Message States:
| Value | Description |
| 0 | PUBLISH sent, waiting for PUBACK (QoS 1 only) |
| 1 | PUBLISH sent, waiting for PUBREC (QoS 2 only) |
| 2 | PUBREC received, sending PUBREL (QoS 2 only) |
| 3 | PUBREL sent, waiting for PUBCOMP (QoS 2 only) |
| 4 | Final acknowledgment received |
Possible Incoming Message States:
| Value | Description |
| 5 | PUBLISH received, sending PUBACK (QoS 1 only) |
| 6 | PUBLISH received, sending PUBREC (QoS 2 only) |
| 7 | PUBREC sent, waiting for PUBREL (QoS 2 only) |
| 8 | PUBREL received, sending PUBCOMP (QoS 2 only) |
| 9 | Final acknowledgment sent |
The index parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.
This property is read-only and not available at design time.
Data Type
Integer