File Explorer

/var/runtime/node_modules/@aws-sdk/node_modules/mqtt-packet

This explorer reads the filesystem of the server it runs on, so /workspace/user isn't present here. Browsing and the terminal still work against this server's own disk from /.

3 dirs
13 files
README.md10.9 KB · 492 lines
mqtt-packet=========== Encode and Decode MQTT 3.1.1, 5.0 packets the node way. [![JavaScript Style Guide](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)   * <a href="#installation">Installation</a>  * <a href="#examples">Examples</a>  * <a href="#packets">Packets</a>  * <a href="#api">API</a>  * <a href="#contributing">Contributing</a>  * <a href="#license">License &amp; copyright</a> This library is tested with node v6, v8, v10, v12 and v14. The last version to supportolder versions of node was mqtt-packet@4.1.2. Installation------------ ```bashnpm install mqtt-packet --save``` Examples-------- ### Generating ```jsconst mqtt = require('mqtt-packet');const object = {  cmd: 'publish',  retain: false,  qos: 0,  dup: false,  length: 10,  topic: 'test',  payload: 'test' // Can also be a Buffer};const opts = { protocolVersion: 4 }; // default is 4. Usually, opts is a connect packet console.log(mqtt.generate(object))// Prints://// <Buffer 30 0a 00 04 74 65 73 74 74 65 73 74>//// Which is the same as://// Buffer.from([//   48, 10, // Header (publish)//   0, 4, // Topic length//   116, 101, 115, 116, // Topic (test)//   116, 101, 115, 116 // Payload (test)// ])``` ### Parsing ```jsconst mqtt = require('mqtt-packet');const opts = { protocolVersion: 4 }; // default is 4. Usually, opts is a connect packetconst parser = mqtt.parser(opts); // Synchronously emits all the parsed packetsparser.on('packet', packet => {  console.log(packet)  // Prints:  //  // {  //   cmd: 'publish',  //   retain: false,  //   qos: 0,  //   dup: false,  //   length: 10,  //   topic: 'test',  //   payload: <Buffer 74 65 73 74>  // }}) parser.parse(Buffer.from([  48, 10, // Header (publish)  0, 4, // Topic length  116, 101, 115, 116, // Topic (test)  116, 101, 115, 116 // Payload (test)]))// Returns the number of bytes left in the parser``` API---   * <a href="#generate"><code>mqtt#<b>generate()</b></code></a>  * <a href="#writeToStream"><code>mqtt#<b>writeToStream()</b></code></a>  * <a href="#parser"><code>mqtt#<b>parser()</b></code></a> <a name="generate"> ### mqtt.generate(object, [opts]) Generates a `Buffer` containing an MQTT packet.The object must be one of the ones specified by the [packets](#packets)section. Throws an `Error` if a packet cannot be generated. <a name="writeToStream"> ### mqtt.writeToStream(object, stream, [opts]) Writes the mqtt packet defined by `object` to the given stream.The object must be one of the ones specified by the [packets](#packets)section. Emits an `Error` on the stream if a packet cannot be generated.On node >= 0.12, this function automatically calls `cork()` on your stream,and then it calls `uncork()` on the next tick.By default cache for number buffers is enabled.It creates a list of buffers for faster write. To disable cache set `mqtt.writeToStream.cacheNumbers = false`.Should be set before any `writeToStream` calls. <a name="parser"> ### mqtt.parser([opts]) Returns a new `Parser` object. `Parser` inherits from `EventEmitter` andwill emit:   * `packet`, when a new packet is parsed, according to    [packets](#packets)  * `error`, if an error happens <a name="parse"> #### Parser.parse(buffer) Parses a given `Buffer` and emits synchronously all the MQTT packets thatare included. Returns the number of bytes left to parse. If an error happens, an `error` event will be emitted, but no `packet` eventswill be emitted after that. Calling `parse()` again clears the error andprevious buffer, as if you created a new `Parser`. Packets------- This section describes the format of all packets emitted by the `Parser`and that you can input to `generate`. ### Connect ```js{  cmd: 'connect',  protocolId: 'MQTT', // Or 'MQIsdp' in MQTT 3.1 and 5.0  protocolVersion: 4, // Or 3 in MQTT 3.1, or 5 in MQTT 5.0  clean: true, // Can also be false  clientId: 'my-device',  keepalive: 0, // Seconds which can be any positive number, with 0 as the default setting  username: 'matteo',  password: Buffer.from('collina'), // Passwords are buffers  will: {    topic: 'mydevice/status',    payload: Buffer.from('dead'), // Payloads are buffers    properties: { // MQTT 5.0      willDelayInterval: 1234,      payloadFormatIndicator: false,      messageExpiryInterval: 4321,      contentType: 'test',      responseTopic: 'topic',      correlationData: Buffer.from([1, 2, 3, 4]),      userProperties: {        'test': 'test'      }    }  },  properties: { // MQTT 5.0 properties      sessionExpiryInterval: 1234,      receiveMaximum: 432,      maximumPacketSize: 100,      topicAliasMaximum: 456,      requestResponseInformation: true,      requestProblemInformation: true,      userProperties: {        'test': 'test'      },      authenticationMethod: 'test',      authenticationData: Buffer.from([1, 2, 3, 4])  }}``` If `protocolVersion` is 3, `clientId` is mandatory and `generate` will throw ifmissing. If `password` or `will.payload` are passed as strings, they willautomatically be converted into a `Buffer`. ### Connack ```js{  cmd: 'connack',  returnCode: 0, // Or whatever else you see fit MQTT < 5.0  sessionPresent: false, // Can also be true.  reasonCode: 0, // reason code MQTT 5.0  properties: { // MQTT 5.0 properties      sessionExpiryInterval: 1234,      receiveMaximum: 432,      maximumQoS: 2,      retainAvailable: true,      maximumPacketSize: 100,      assignedClientIdentifier: 'test',      topicAliasMaximum: 456,      reasonString: 'test',      userProperties: {        'test': 'test'      },      wildcardSubscriptionAvailable: true,      subscriptionIdentifiersAvailable: true,      sharedSubscriptionAvailable: false,      serverKeepAlive: 1234,      responseInformation: 'test',      serverReference: 'test',      authenticationMethod: 'test',      authenticationData: Buffer.from([1, 2, 3, 4])  }}``` The only mandatory argument is `returnCode`, as `generate` will throw ifmissing. ### Subscribe ```js{  cmd: 'subscribe',  messageId: 42,  properties: { // MQTT 5.0 properties    subscriptionIdentifier: 145,    userProperties: {      test: 'test'    }  }  subscriptions: [{    topic: 'test',    qos: 0,    nl: false, // no Local MQTT 5.0 flag    rap: true, // Retain as Published MQTT 5.0 flag    rh: 1 // Retain Handling MQTT 5.0  }]}``` All properties are mandatory. ### Suback ```js{  cmd: 'suback',  messageId: 42,  properties: { // MQTT 5.0 properties    reasonString: 'test',    userProperties: {      'test': 'test'    }  }  granted: [0, 1, 2, 128]}``` All the granted qos __must__ be < 256, as they are encoded as UInt8.All properties are mandatory. ### Unsubscribe ```js{  cmd: 'unsubscribe',  messageId: 42,  properties: { // MQTT 5.0 properties    userProperties: {      'test': 'test'    }  }  unsubscriptions: [    'test',    'a/topic'  ]}``` All properties are mandatory. ### Unsuback ```js{  cmd: 'unsuback',  messageId: 42,  properties: { // MQTT 5.0 properties    reasonString: 'test',    userProperties: {      'test': 'test'    }  }}``` All properties are mandatory. ### Publish ```js{  cmd: 'publish',  messageId: 42,  qos: 2,  dup: false,  topic: 'test',  payload: Buffer.from('test'),  retain: false,  properties: { // optional properties MQTT 5.0      payloadFormatIndicator: true,      messageExpiryInterval: 4321,      topicAlias: 100,      responseTopic: 'topic',      correlationData: Buffer.from([1, 2, 3, 4]),      userProperties: {        'test': 'test'      },      subscriptionIdentifier: 120, // can be an Array in message from broker, if message included in few another subscriptions      contentType: 'test'   }}``` Only the `topic` property is mandatory.Both `topic` and `payload` can be `Buffer` objects instead of strings.`messageId` is mandatory for `qos > 0`. ### Puback ```js{  cmd: 'puback',  messageId: 42,  reasonCode: 16, // only for MQTT 5.0  properties: { // MQTT 5.0 properties      reasonString: 'test',      userProperties: {        'test': 'test'      }  }}``` The only mandatory property is `messageId`, as `generate` will throw ifmissing. ### Pubrec ```js{  cmd: 'pubrec',  messageId: 42,  reasonCode: 16, // only for MQTT 5.0  properties: { // properties MQTT 5.0    reasonString: 'test',    userProperties: {      'test': 'test'    }  }}``` The only mandatory property is `messageId`, as `generate` will throw ifmissing. ### Pubrel ```js{  cmd: 'pubrel',  messageId: 42,  reasonCode: 16, // only for MQTT 5.0  properties: { // properties MQTT 5.0     reasonString: 'test',     userProperties: {       'test': 'test'     }  }}``` The only mandatory property is `messageId`, as `generate` will throw ifmissing. ### Pubcomp ```js{  cmd: 'pubcomp',  messageId: 42,  reasonCode: 16, // only for MQTT 5.0  properties: { // properties MQTT 5.0    reasonString: 'test',    userProperties: {       'test': 'test'    }  }}``` The only mandatory property is `messageId`, as `generate` will throw ifmissing. ### Pingreq ```js{  cmd: 'pingreq'}``` ### Pingresp ```js{  cmd: 'pingresp'}``` ### Disconnect ```js{  cmd: 'disconnect',  reasonCode: 0, // MQTT 5.0 code  properties: { // properties MQTT 5.0     sessionExpiryInterval: 145,     reasonString: 'test',     userProperties: {       'test': 'test'     },     serverReference: 'test'  }}``` ### Auth ```js{  cmd: 'auth',  reasonCode: 0, // MQTT 5.0 code  properties: { // properties MQTT 5.0     authenticationMethod: 'test',     authenticationData: Buffer.from([0, 1, 2, 3]),     reasonString: 'test',     userProperties: {       'test': 'test'     }  }}``` <a name="contributing"></a> Contributing------------ mqtt-packet is an **OPEN Open Source Project**. This means that: > Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project. See the [CONTRIBUTING.md](https://github.com/mqttjs/mqtt-packet/blob/master/CONTRIBUTING.md) file for more details. ### Contributors mqtt-packet is only possible due to the excellent work of the following contributors: <table><tbody><tr><th align="left">Matteo Collina</th><td><a href="https://github.com/mcollina">GitHub/mcollina</a></td><td><a href="http://twitter.com/matteocollina">Twitter/@matteocollina</a></td></tr><tr><th align="left">Adam Rudd</th><td><a href="https://github.com/adamvr">GitHub/adamvr</a></td><td><a href="http://twitter.com/adam_vr">Twitter/@adam_vr</a></td></tr><tr><th align="left">Peter Sorowka</th><td><a href="https://github.com/psorowka">GitHub/psorowka</a></td><td><a href="http://twitter.com/psorowka">Twitter/@psorowka</a></td></tr><tr><th align="left">Siarhei Buntsevich</th><td><a href="https://github.com/scarry1992">GitHub/scarry1992</a></td></tr></tbody></table> License------- MIT