From 990a221cb5add0746b375b0032c2510c515bb21f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Zihua=20=E5=AD=90=E9=AA=85?= <luin@users.noreply.github.com>
Date: Fri, 2 Dec 2016 22:57:52 +0800
Subject: [PATCH] perf: by default call setNoDelay on the stream (#406)

Disables Nagle's algorithm on the underlaying socket by default. Can be controlled via `options.noDelay`
---
 API.md               | 5 +++--
 lib/cluster/index.js | 1 +
 lib/redis.js         | 7 +++++++
 3 files changed, 11 insertions(+), 2 deletions(-)

diff --git a/API.md b/API.md
index ca1897e6..00162fdf 100644
--- a/API.md
+++ b/API.md
@@ -56,6 +56,7 @@ Creates a Redis instance
 | [options.family] | <code>string</code> | <code>4</code> | Version of IP stack. Defaults to 4. |
 | [options.path] | <code>string</code> | <code>null</code> | Local domain socket path. If set the `port`, `host` and `family` will be ignored. |
 | [options.keepAlive] | <code>number</code> | <code>0</code> | TCP KeepAlive on the socket with a X ms delay before start. Set to a non-number value to disable keepAlive. |
+| [options.noDelay] | <code>boolean</code> | <code>true</code> | Whether to disable the Nagle's Algorithm. By default we disable it to reduce the latency. |
 | [options.connectionName] | <code>string</code> | <code>null</code> | Connection name. |
 | [options.db] | <code>number</code> | <code>0</code> | Database index to use. |
 | [options.password] | <code>string</code> | <code>null</code> | If set, client will send AUTH command with the value of this option when connected. |
@@ -99,7 +100,7 @@ This method will be invoked automatically when creating a new Redis instance.
 
 | Param | Type |
 | --- | --- |
-| callback | <code>function</code> |
+| callback | <code>function</code> | 
 
 <a name="Redis+disconnect"></a>
 
@@ -270,7 +271,7 @@ Quit the cluster gracefully.
 
 | Param | Type |
 | --- | --- |
-| callback | <code>function</code> |
+| callback | <code>function</code> | 
 
 <a name="Cluster+nodes"></a>
 
diff --git a/lib/cluster/index.js b/lib/cluster/index.js
index 61620a91..006653b9 100644
--- a/lib/cluster/index.js
+++ b/lib/cluster/index.js
@@ -179,6 +179,7 @@ Cluster.prototype.connect = function () {
 
 /**
  * Called when closed to check whether a reconnection should be made
+ * @private
  */
 Cluster.prototype._handleCloseEvent = function () {
   var retryDelay;
diff --git a/lib/redis.js b/lib/redis.js
index ca2bb88b..f24f687a 100644
--- a/lib/redis.js
+++ b/lib/redis.js
@@ -33,6 +33,8 @@ var commands = require('redis-commands');
  * `host` and `family` will be ignored.
  * @param {number} [options.keepAlive=0] - TCP KeepAlive on the socket with a X ms delay before start.
  * Set to a non-number value to disable keepAlive.
+ * @param {boolean} [options.noDelay=true] - Whether to disable the Nagle's Algorithm. By default we disable
+ * it to reduce the latency.
  * @param {string} [options.connectionName=null] - Connection name.
  * @param {number} [options.db=0] - Database index to use.
  * @param {string} [options.password=null] - If set, client will send AUTH command
@@ -159,6 +161,7 @@ Redis.defaultOptions = {
     return Math.min(times * 2, 2000);
   },
   keepAlive: 0,
+  noDelay: true,
   connectionName: null,
   // Sentinel
   sentinels: null,
@@ -295,6 +298,10 @@ Redis.prototype.connect = function (callback) {
         });
       }
 
+      if (_this.options.noDelay) {
+        stream.setNoDelay(true);
+      }
+
       var connectionConnectHandler = function () {
         _this.removeListener('close', connectionCloseHandler);
         resolve();