Merge pull request #75 from renatoc/master

Emit an event when the server receives a ping

README.md

@@ -103,6 +103,9 @@ Events:
 * `ack`: when a packet published to a client is delivered successfully with QoS 1 or QoS 2, arguments:
   1. `packet`
   2. `client`
+* `ping`: when a [Client](#client) sends a ping, arguments:
+  1. `packet`
+  2. `client`
 * `subscribe`: when a client sends a SUBSCRIBE, arguments:
   1. `subscriptions`, as defined in the `subscriptions` property of the
      [SUBSCRIBE](https://github.com/mqttjs/mqtt-packet#subscribe)
@@ -188,9 +191,9 @@ instance.authenticate = function (client, username, password, callback) {
 ```
 The return code values and their responses which can be passed are given below :-
 
-*  `1` - Unacceptable protocol version 
-*  `2` - Identifier rejected 
-*  `3` - Server unavailable 
+*  `1` - Unacceptable protocol version
+*  `2` - Identifier rejected
+*  `3` - Server unavailable
 *  `4` - Bad user name or password
 
 -------------------------------------------------------

lib/handlers/index.js

@@ -1,13 +1,13 @@
 'use strict'
 
-var write = require('../write')
 var handleConnect = require('./connect')
 var handleSubscribe = require('./subscribe')
 var handleUnsubscribe = require('./unsubscribe')
 var handlePublish = require('./publish')
 var handlePuback = require('./puback')
 var handlePubrel = require('./pubrel')
 var handlePubrec = require('./pubrec')
+var handlePing = require('./ping')
 
 function handle (client, packet, done) {
   if (packet.cmd !== 'connect' && !client.connected) {
@@ -43,9 +43,7 @@ function handle (client, packet, done) {
       handlePubrec(client, packet, done)
       break
     case 'pingreq':
-      write(client, {
-        cmd: 'pingresp'
-      }, done)
+      handlePing(client, packet, done)
       break
     case 'disconnect':
       client.disconnected = true

lib/handlers/ping.js

@@ -0,0 +1,12 @@
+'use strict'
+var write = require('../write')
+
+function handlePing (client, packet, done) {
+  client.broker.emit('ping', packet, client)
+  write(client, {
+    cmd: 'pingresp'
+  }, done)
+  done()
+}
+
+module.exports = handlePing

test/events.js

@@ -66,3 +66,27 @@ test('does not store $SYS topics to QoS 1 # subscription', function (t) {
     })
   })
 })
+
+test('Emit event when receives a ping', function (t) {
+  t.plan(6)
+  t.timeoutAfter(2000)
+  var broker = aedes()
+
+  broker.on('ping', function (packet, client) {
+    if (client && client) {
+      t.equal(client.id, 'abcde')
+      t.equal(packet.cmd, 'pingreq')
+      t.equal(packet.payload, null)
+      t.equal(packet.topic, null)
+      t.equal(packet.length, 0)
+      broker.close()
+      t.pass('ended')
+    }
+  })
+
+  var s = connect(setup(broker), { clientId: 'abcde' })
+
+  s.inStream.write({
+    cmd: 'pingreq'
+  })
+})