Merge pull request mqttjs#387 from gkwicker/patch-2

mcollina · mcollina · commit e85de21f1d05 · 2016-04-10T12:19:09.000+02:00
Introduce 'fastClientDisconnectDetect' option
diff --git a/README.md b/README.md
@@ -174,6 +174,7 @@ The arguments are:
 the `connect` event. Typically a `net.Socket`.
 * `options` is the client connection options (see: the [connect packet](https://github.com/mcollina/mqtt-packet#connect)). Defaults:
   * `keepalive`: `10` seconds, set to `0` to disable
+  * `reschedulePings`: reschedule ping messages after sending packets (default `true`)
   * `clientId`: `'mqttjs_' + Math.random().toString(16).substr(2, 8)`
   * `protocolId`: `'MQTT'`
   * `protocolVersion`: `4`
diff --git a/lib/client.js b/lib/client.js
@@ -16,6 +16,7 @@ var events = require('events'),
   },
   defaultConnectOptions = {
     keepalive: 10,
+    reschedulePings: true,
     protocolId: 'MQTT',
     protocolVersion: 4,
     reconnectPeriod: 1000,
@@ -642,7 +643,7 @@ MqttClient.prototype._setupPingTimer = function () {
  * @api private
  */
 MqttClient.prototype._shiftPingInterval = function () {
-  if (this.pingTimer && this.options.keepalive) {
+  if (this.pingTimer && this.options.keepalive && this.options.reschedulePings) {
     this.pingTimer.reschedule(this.options.keepalive * 1000);
   }
 };
diff --git a/test/abstract_client.js b/test/abstract_client.js
@@ -605,6 +605,38 @@ module.exports = function (server, config) {
         done();
       });
     });
+    it('should not checkPing if publishing at a higher rate than keepalive', function (done) {
+      var intervalMs = 3000,
+        client = connect({keepalive: intervalMs / 1000});
+
+      client._checkPing = sinon.spy();
+
+      client.once('connect', function () {
+        client.publish('foo', 'bar');
+        clock.tick(intervalMs - 1);
+        client.publish('foo', 'bar');
+        clock.tick(2);
+        client._checkPing.callCount.should.equal(0);
+        client.end();
+        done();
+      });
+    });
+    it('should checkPing if publishing at a higher rate than keepalive and reschedulePings===false', function (done) {
+      var intervalMs = 3000,
+        client = connect({keepalive: intervalMs / 1000,reschedulePings:false});
+
+      client._checkPing = sinon.spy();
+
+      client.once('connect', function () {
+        client.publish('foo', 'bar');
+        clock.tick(intervalMs - 1);
+        client.publish('foo', 'bar');
+        clock.tick(2);
+        client._checkPing.callCount.should.equal(1);
+        client.end();
+        done();
+      });
+    });
   });
 
   describe('pinging', function () {
