Skip to content

Commit

Permalink
net,dgram: return this from ref and unref methods
Browse files Browse the repository at this point in the history
Modifies the following methods to return the instance instead
of undefined, to allow for chaining these methods:

- net.Server.ref
- net.Server.unref
- net.Socket.ref
- net.Socket.unref
- dgram.Socket.ref
- dgram.Socket.unref

PR-URL: #1768
Reviewed-By: Evan Lucas <evanlucas@me.com>
  • Loading branch information
silverwind committed May 23, 2015
1 parent 9da168b commit 39dde32
Show file tree
Hide file tree
Showing 5 changed files with 38 additions and 2 deletions.
4 changes: 4 additions & 0 deletions doc/api/dgram.markdown
Expand Up @@ -306,8 +306,12 @@ Calling `unref` on a socket will allow the program to exit if this is the only
active socket in the event system. If the socket is already `unref`d calling
`unref` again will have no effect.

Returns `socket`.

### socket.ref()

Opposite of `unref`, calling `ref` on a previously `unref`d socket will *not*
let the program exit if it's the only socket left (the default behavior). If
the socket is `ref`d calling `ref` again will have no effect.

Returns `socket`.
8 changes: 8 additions & 0 deletions doc/api/net.markdown
Expand Up @@ -261,12 +261,16 @@ Calling `unref` on a server will allow the program to exit if this is the only
active server in the event system. If the server is already `unref`d calling
`unref` again will have no effect.

Returns `server`.

### server.ref()

Opposite of `unref`, calling `ref` on a previously `unref`d server will *not*
let the program exit if it's the only server left (the default behavior). If
the server is `ref`d calling `ref` again will have no effect.

Returns `server`.

### server.maxConnections

Set this property to reject connections when the server's connection count gets
Expand Down Expand Up @@ -484,12 +488,16 @@ Calling `unref` on a socket will allow the program to exit if this is the only
active socket in the event system. If the socket is already `unref`d calling
`unref` again will have no effect.

Returns `socket`.

### socket.ref()

Opposite of `unref`, calling `ref` on a previously `unref`d socket will *not*
let the program exit if it's the only socket left (the default behavior). If
the socket is `ref`d calling `ref` again will have no effect.

Returns `socket`.

### socket.remoteAddress

The string representation of the remote IP address. For example,
Expand Down
4 changes: 4 additions & 0 deletions lib/dgram.js
Expand Up @@ -481,10 +481,14 @@ function onMessage(nread, handle, buf, rinfo) {
Socket.prototype.ref = function() {
if (this._handle)
this._handle.ref();

return this;
};


Socket.prototype.unref = function() {
if (this._handle)
this._handle.unref();

return this;
};
12 changes: 10 additions & 2 deletions lib/net.js
Expand Up @@ -984,20 +984,24 @@ function connectErrorNT(self, err, options) {
Socket.prototype.ref = function() {
if (!this._handle) {
this.once('connect', this.ref);
return;
return this;
}

this._handle.ref();

return this;
};


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

this._handle.unref();

return this;
};


Expand Down Expand Up @@ -1506,13 +1510,17 @@ Server.prototype.ref = function() {

if (this._handle)
this._handle.ref();

return this;
};

Server.prototype.unref = function() {
this._unref = true;

if (this._handle)
this._handle.unref();

return this;
};


Expand Down
12 changes: 12 additions & 0 deletions test/parallel/test-ref-unref-return.js
@@ -0,0 +1,12 @@
'use strict';
var assert = require('assert');
var net = require('net');
var dgram = require('dgram');
var common = require('../common');

assert.ok((new net.Server()).ref() instanceof net.Server);
assert.ok((new net.Server()).unref() instanceof net.Server);
assert.ok((new net.Socket()).ref() instanceof net.Socket);
assert.ok((new net.Socket()).unref() instanceof net.Socket);
assert.ok((new dgram.Socket('udp4')).ref() instanceof dgram.Socket);
assert.ok((new dgram.Socket('udp6')).unref() instanceof dgram.Socket);

0 comments on commit 39dde32

Please sign in to comment.