Skip to content

Commit

Permalink
net: persist net.Socket options before connect
Browse files Browse the repository at this point in the history
Remembers net.Socket options called before connect and retroactively
applies them after the handle has been created.

This change makes the following function calls more user-friendly:

- setKeepAlive()
- setNoDelay()
- ref()
- unref()

Related: nodejs/node-v0.x-archive#7077 and
nodejs/node-v0.x-archive#8572

Fixes: nodejs/node-v0.x-archive#7077
Fixes: nodejs/node-v0.x-archive#8572
PR-URL: #1518
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Roman Reiss <me@silverwind.io>
  • Loading branch information
evanlucas committed May 19, 2015
1 parent 3c44100 commit 85d9983
Show file tree
Hide file tree
Showing 4 changed files with 130 additions and 6 deletions.
31 changes: 25 additions & 6 deletions lib/net.js
Original file line number Diff line number Diff line change
Expand Up @@ -321,14 +321,25 @@ Socket.prototype._onTimeout = function() {


Socket.prototype.setNoDelay = function(enable) {
if (!this._handle) {
this.once('connect',
enable ? this.setNoDelay : this.setNoDelay.bind(this, enable));
return;
}

// backwards compatibility: assume true when `enable` is omitted
if (this._handle && this._handle.setNoDelay)
if (this._handle.setNoDelay)
this._handle.setNoDelay(enable === undefined ? true : !!enable);
};


Socket.prototype.setKeepAlive = function(setting, msecs) {
if (this._handle && this._handle.setKeepAlive)
if (!this._handle) {
this.once('connect', this.setKeepAlive.bind(this, setting, msecs));
return;
}

if (this._handle.setKeepAlive)
this._handle.setKeepAlive(setting, ~~(msecs / 1000));
};

Expand Down Expand Up @@ -971,14 +982,22 @@ function connectErrorNT(self, err, options) {


Socket.prototype.ref = function() {
if (this._handle)
this._handle.ref();
if (!this._handle) {
this.once('connect', this.ref);
return;
}

this._handle.ref();
};


Socket.prototype.unref = function() {
if (this._handle)
this._handle.unref();
if (!this._handle) {
this.once('connect', this.unref);
return;
}

this._handle.unref();
};


Expand Down
33 changes: 33 additions & 0 deletions test/parallel/test-net-persistent-keepalive.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
'use strict';
var common = require('../common');
var assert = require('assert');
var net = require('net');

var serverConnection;
var echoServer = net.createServer(function(connection) {
serverConnection = connection;
connection.setTimeout(0);
assert.equal(typeof connection.setKeepAlive, 'function');
connection.on('end', function() {
connection.end();
});
});
echoServer.listen(common.PORT);

echoServer.on('listening', function() {
var clientConnection = new net.Socket();
// send a keepalive packet after 1000 ms
// and make sure it persists
clientConnection.setKeepAlive(true, 400);
clientConnection.connect(common.PORT);
clientConnection.setTimeout(0);

setTimeout(function() {
// make sure both connections are still open
assert.equal(serverConnection.readyState, 'open');
assert.equal(clientConnection.readyState, 'open');
serverConnection.end();
clientConnection.end();
echoServer.close();
}, 600);
});
33 changes: 33 additions & 0 deletions test/parallel/test-net-persistent-nodelay.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
'use strict';
var common = require('../common');
var assert = require('assert');
var net = require('net');
var TCPWrap = process.binding('tcp_wrap').TCP;

var echoServer = net.createServer(function(connection) {
connection.end();
});
echoServer.listen(common.PORT);

var callCount = 0;

var Socket = net.Socket;
var setNoDelay = TCPWrap.prototype.setNoDelay;

TCPWrap.prototype.setNoDelay = function(enable) {
setNoDelay.call(this, enable);
callCount++;
};

echoServer.on('listening', function() {
var sock1 = new Socket();
// setNoDelay before the handle is created
// there is probably a better way to test this

sock1.setNoDelay();
sock1.connect(common.PORT);
sock1.on('end', function() {
assert.equal(callCount, 1);
echoServer.close();
});
});
39 changes: 39 additions & 0 deletions test/parallel/test-net-persistent-ref-unref.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
'use strict';
var common = require('../common');
var assert = require('assert');
var net = require('net');
var TCPWrap = process.binding('tcp_wrap').TCP;

var echoServer = net.createServer(function(conn) {
conn.end();
});

var ref = TCPWrap.prototype.ref;
var unref = TCPWrap.prototype.unref;

var refCount = 0;

TCPWrap.prototype.ref = function() {
ref.call(this);
refCount++;
assert.equal(refCount, 0);
};

TCPWrap.prototype.unref = function() {
unref.call(this);
refCount--;
assert.equal(refCount, -1);
};

echoServer.listen(common.PORT);

echoServer.on('listening', function() {
var sock = new net.Socket();
sock.unref();
sock.ref();
sock.connect(common.PORT);
sock.on('end', function() {
assert.equal(refCount, 0);
echoServer.close();
});
});

1 comment on commit 85d9983

@mscdex
Copy link
Contributor

@mscdex mscdex commented on 85d9983 May 19, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

\o/

Please sign in to comment.