Aedes ![Build Status](https://travis-ci.org/mcollina/aedes.png)
Barebone MQTT server that can run on any stream server.
![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)
Install
To install aedes, simply use npm:
npm install aedes --save
Example
var aedes = require('./aedes')()
var server = require('net').createServer(aedes.handle)
var port = 1883
server.listen(port, function () {
console.log('server listening on port', port)
})
API
aedes([opts])
Creates a new instance of Aedes.
Options:
mq
: an instance of MQEmitter.concurrency
: the max number of messages delivered concurrently,
defaults to 100
.heartbeatInterval
: the interval at which the broker heartbeat is
emitted, it used by other broker in the cluster, the default is
60000
milliseconds.connectTimeout
: the max number of milliseconds to wait for the CONNECT
packet to arrive, defaults to 30000
milliseconds.
Events:
client
: when a new Client connects, arguments:
client
clientDisconnect
: when a Client disconnects, arguments:
client
clientError
: when a Client errors, arguments:
client
err
publish
: when a new packet is published, arguments:
packet
client
subscribe
: when a client sends a SUBSCRIBE, arguments:
subscriptions
, as defined in the subscriptions
property of the
SUBSCRIBE
packet.client
unsubscribe
: when a client sends a UNSUBSCRIBE, arguments:
unsubscriptions
, as defined in the subscriptions
property of the
UNSUBSCRIBE
packet.client
instance.handle(duplex)
Handle the given duplex as a MQTT connection.
var aedes = require('./aedes')()
var server = require('net').createServer(aedes.handle)
instance.subscribe(topic, func(packet, cb), done)
After done
is called, every time publish is invoked on the
instance (and on any other connected instances) with a matching topic
the func
function will be called. It also support retained messages lookup.
func
needs to call cb
after receiving the message.
It supports backpressure.
instance.publish(packet, done)
Publish the given packet to subscribed clients and functions. A packet
must be valid for mqtt-packet.
It supports backpressure.
instance.unsubscribe(topic, func(packet, cb), done)
The reverse of subscribe.
instance.authenticate(client, username, password, done(err, successful))
It will be called when a new client connects. Ovverride to supply custom
authentication logic.
instance.authenticate = function (client, username, password, callback) {
callback(null, username === 'matteo')
}
instance.authorizePublish(client, packet, done(err))
It will be called when a client publishes a message. Ovverride to supply custom
authorization logic.
instance.authorizePublish = function (client, packet, callback) {
if (packet.topic === 'aaaa') {
return callback(new Error('wrong topic'))
}
if (packet.topic === 'bbb') {
packet.payload = new Buffer('overwrite packet payload')
}
callback(null)
}
instance.authorizeSubscribe(client, pattern, done(err, pattern))
It will be called when a client publishes a message. Ovverride to supply custom
authorization logic.
instance.authorizeSubscribe = function (client, sub, cb) {
if (sub === 'aaaa') {
return cb(new Error('wrong topic'))
}
if (sub === 'bbb') {
sub = '42'
}
callback(null, sub)
}
instance.published(packet, client, done())
It will be after a message is published.
client
will be null for internal messages.
Ovverride to supply custom authorization logic.
instance.close([cb])
Disconnects all clients.
Client
Classes for all connected clients.
Events:
error
, in case something bad happended
client#publish(message, [callback])
Publish the given message
to this client. QoS 1 and 2 are fully
respected, while the retained flag is not.
message
is a PUBLISH packet.
callback
will be called when the message has been sent, but not acked.
client#subscribe(subscriptions, [callback])
Subscribe the client to the list of topics.
subscription
can be:
- a single object in the format
{ topic: topic, qos: qos }
- an array of the above
- a full subscribe
packet,
specifying a
messageId
will send suback to the client.
callback
will be called when the subscription is completed.
client#close([cb])
Disconnects the client
Todo
Acknowledgements
This library is born after a lot of discussion with all
Mosca users, and how that was deployed in
production. This addresses your concerns about performance and
stability.
License
MIT