IPWorks IoT 2020 Node.js Edition

Questions / Feedback?

Version Property

The MQTT protocol version that the class will conform to.

Syntax

 mqtt.getVersion([callback])
 mqtt.setVersion( version, [callback])

Possible Values

  0 (mvV3), 
  1 (mvV5)

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 getVersion([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 setVersion([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 property specifies the version of the MQTT protocol to use. Possible values are:

0 (mvV3 - default) MQTT 3.1.1
1 (mvV5) MQTT 5

This property must be set before connecting.

This property is 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]