mqtt-connection
Advanced tools
Readme
Barebone Connection object for MQTT. Works over any kind of binary Streams, TCP, TLS, WebSocket, ...
It uses mqtt-packet for generating and parsing MQTT packets. See it for the full documentations on the packet types.
This library works with node v0.10 and node v0.8, but it requires at
least NPM 1.4. To upgrade on node v0.8, run npm install npm@v1.4-latest -g.
npm install mqtt-connection --save
As a client:
var net = require('net')
, mqttCon = require('mqtt-connection')
, stream = net.createConnection(1883, 'localhost')
, conn = mqttCon(stream);
// conn is your MQTT connection!
As a server:
var net = require('net')
, mqttCon = require('mqtt-connection')
, server = new net.Server();
server.on('connection', function(stream) {
var conn = mqttCon(stream);
// conn is your MQTT connection!
});
As a websocket server:
var websocket = require('websocket-stream')
, WebSocketServer = require('ws').Server
, Connection = require('mqtt-connection')
, server = http.createServer()
function attachWebsocketServer(server, handler) {
var wss = new WebSocketServer({server: server})
if (handler)
server.on('client', handler)
wss.on('connection', function(ws) {
var stream = websocket(ws)
var connection = new Connection(stream)
server.emit("client", connection)
})
return server
}
attachWebsocketServer(server)
Creates a new MQTT Connection.
Options:
notData: do not listen to the 'data' event, so that it can
respect backpressure. Pipe the Connection to another stream to
consume the packets. If this option is passed true the object will
emit no packet-related events.Send an MQTT connect packet.
options supports the following properties:
protocolId: Protocol ID, usually MQIsdp. stringprotocolVersion: Protocol version, usually 3. numberkeepalive: keepalive period in seconds. numberclientId: client ID. stringwill: the client's will message options.
object that supports the following properties:
topic: the will topic. stringpayload: the will payload. stringqos: will qos level. numberretain: will retain flag. booleanclean: the 'clean start' flag. booleanusername: username for protocol v3.1. stringpassword: password for protocol v3.1. stringSend an MQTT connack packet.
options supports the following properties:
returnCode: the return code of the connack, success is
indicated by 0. numberSend an MQTT publish packet.
options supports the following properties:
topic: the topic to publish to. stringpayload: the payload to publish, defaults to an empty buffer.
string or bufferqos: the quality of service level to publish on. numbermessageId: the message ID of the packet,
required if qos > 0. numberretain: retain flag. booleanSend an MQTT [puback, pubrec, pubcomp, unsuback] packet.
options supports the following properties:
messageId: the ID of the packetSend an MQTT pubrel packet.
options supports the following properties:
dup: duplicate message flagmessageId: the ID of the packetSend an MQTT subscribe packet.
options supports the following properties:
dup: duplicate message flagmessageId: the ID of the packetsubscriptions: a list of subscriptions of the form
[{topic: a, qos: 0}, {topic: b, qos: 1}]Send an MQTT suback packet.
options supports the following properties:
granted: a vector of granted QoS levels,
of the form [0, 1, 2]messageId: the ID of the packetSend an MQTT unsubscribe packet.
options supports the following properties:
messageId: the ID of the packetdup: duplicate message flagunsubscriptions: a list of topics to unsubscribe from,
of the form ["topic1", "topic2"]Send an MQTT [pingreq, pingresp, disconnect] packet.
function(packet) {}
Emitted when an MQTT connect packet is received by the client.
packet is an object that may have the following properties:
version: the protocol version stringversionNum: the protocol version numberkeepalive: the client's keepalive periodclientId: the client's IDwill: an object with the following keys:
topic: the client's will topicpayload: the will messageretain: will retain flagqos: will qos levelclean: clean start flagusername: v3.1 usernamepassword: v3.1 passwordfunction(packet) {}
Emitted when an MQTT connack packet is received by the client.
packet is an object that may have the following properties:
returnCode: the return code of the connack packetfunction(packet) {}
Emitted when an MQTT publish packet is received by the client.
packet is an object that may have the following properties:
topic: the topic the message is published onpayload: the payload of the messagemessageId: the ID of the packetqos: the QoS level to publish atfunction(packet) {}
Emitted when an MQTT [puback, pubrec, pubrel, pubcomp, unsuback]
packet is received by the client.
packet is an object that may contain the property:
messageId: the ID of the packetfunction(packet) {}
Emitted when an MQTT subscribe packet is received.
packet is an object that may contain the properties:
messageId: the ID of the packetsubscriptions: an array of objects
representing the subscribed topics, containing the following keys
topic: the topic subscribed toqos: the qos level of the subscriptionfunction(packet) {}
Emitted when an MQTT suback packet is received.
packet is an object that may contain the properties:
messageId: the ID of the packetgranted: a vector of granted QoS levelsfunction(packet) {}
Emitted when an MQTT unsubscribe packet is received.
packet is an object that may contain the properties:
messageId: the ID of the packetunsubscriptions: a list of topics the client is
unsubscribing from, of the form [topic1, topic2, ...]function(packet){}
Emitted when an MQTT [pingreq, pingresp, disconnect] packet is received.
packet only includes static header information and can be ignored.
Returns a Transform stream that calls generate().
The stream is configured into object mode.
Returns a Transform stream that embeds a Parser and calls Parser.parse() for each new Buffer. The stream is configured into object mode. It accepts the same options of parser(opts).
mqtt-connection 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 file for more details.
mqtt-packet is only possible due to the excellent work of the following contributors:
| Matteo Collina | GitHub/mcollina | Twitter/@matteocollina |
|---|---|---|
| Adam Rudd | GitHub/adamvr | Twitter/@adam_vr |
MIT
FAQs
Stream-based Connection object for MQTT, extracted from MQTT.js
The npm package mqtt-connection receives a total of 59,137 weekly downloads. As such, mqtt-connection popularity was classified as popular.
We found that mqtt-connection demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A hospital in Mobile, Alabama, agreed to a settlement in a landmark ransomware death lawsuit, but is now reportedly reconsidering the agreement and refusing to pay.
Security News
A new report explores how advancements in LLMs are enhancing cyber threats, including polymorphic malware, personalized spearphishing, and the risk of hijacking customer service bots.
Security News
ESLint has approved an RFC that adds support for TypeScript configuration files, which is aimed at improving the developer experience and recognizing changes in the evolving JavaScript ecosystem.