Skip to content
This repository has been archived by the owner on Apr 22, 2023. It is now read-only.

net: add pauseOnConnect option to createServer() #8576

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion doc/api/net.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,21 @@ automatically set as a listener for the ['connection'][] event.

`options` is an object with the following defaults:

{ allowHalfOpen: false
{
allowHalfOpen: false,
pauseOnConnect: false
}

If `allowHalfOpen` is `true`, then the socket won't automatically send a FIN
packet when the other end of the socket sends a FIN packet. The socket becomes
non-readable, but still writable. You should call the `end()` method explicitly.
See ['end'][] event for more information.

If `pauseOnConnect` is `true`, then the socket associated with each incoming
connection will be paused, and no data will be read from its handle. This allows
connections to be passed between processes without any data being read by the
original process. To begin reading data from a paused socket, call `resume()`.

Here is an example of an echo server which listens for connections
on port 8124:

Expand Down
15 changes: 12 additions & 3 deletions lib/net.js
Original file line number Diff line number Diff line change
Expand Up @@ -180,8 +180,15 @@ function Socket(options) {

// if we have a handle, then start the flow of data into the
// buffer. if not, then this will happen when we connect
if (this._handle && options.readable !== false)
this.read(0);
if (this._handle && options.readable !== false) {
if (options.pauseOnCreate) {
// stop the handle from reading and pause the stream
this._handle.reading = false;
this._handle.readStop();
this._readableState.flowing = false;
} else
this.read(0);

Choose a reason for hiding this comment

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

style nit: if one part of an if/else uses brackets all of them should. don't worry about fixing it though. i'll take care of it before merging.

}
}
util.inherits(Socket, stream.Duplex);

Expand Down Expand Up @@ -1024,6 +1031,7 @@ function Server(options, connectionListener) {
this._slaves = [];

this.allowHalfOpen = options.allowHalfOpen || false;
this.pauseOnConnect = !!options.pauseOnConnect;
}
util.inherits(Server, events.EventEmitter);
exports.Server = Server;
Expand Down Expand Up @@ -1287,7 +1295,8 @@ function onconnection(err, clientHandle) {

var socket = new Socket({
handle: clientHandle,
allowHalfOpen: self.allowHalfOpen
allowHalfOpen: self.allowHalfOpen,
pauseOnCreate: self.pauseOnConnect
});
socket.readable = socket.writable = true;

Expand Down
59 changes: 59 additions & 0 deletions test/simple/test-net-server-pause-on-connect.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
// Copyright Joyent, Inc. and other Node contributors.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to permit
// persons to whom the Software is furnished to do so, subject to the
// following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
// USE OR OTHER DEALINGS IN THE SOFTWARE.

var common = require('../common');
var assert = require('assert');
var net = require('net');
var msg = 'test';
var stopped = true;
var server1 = net.createServer({pauseOnConnect: true}, function(socket) {
socket.on('data', function(data) {
if (stopped) {
assert(false, 'data event should not happen');

Choose a reason for hiding this comment

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

Sound like the data event should never fire. Going to change it to read:

data event should not have happened yet

}

assert.equal(data.toString(), msg, 'invalid data received');
socket.end();
server1.close();
});

setTimeout(function() {
assert.equal(socket.bytesRead, 0, 'no data should be read');

Choose a reason for hiding this comment

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

Also going to make this message more explicit.

socket.resume();
stopped = false;
}, 3000);
});

var server2 = net.createServer({pauseOnConnect: false}, function(socket) {
socket.on('data', function(data) {
assert.equal(data.toString(), msg, 'invalid data received');
socket.end();
server2.close();
});
});

server1.listen(common.PORT, function() {
net.createConnection({port: common.PORT}).write(msg);
});

server2.listen(common.PORT + 1, function() {
net.createConnection({port: common.PORT + 1}).write(msg);
});