Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

dgram: deprecate all previous private APIs #22011

Merged
merged 1 commit into from
Aug 7, 2018
Merged

dgram: deprecate all previous private APIs #22011

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions doc/api/deprecations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1009,6 +1009,18 @@ Type: Documentation-only
The `process.binding()` API is intended for use by Node.js internal code
only. Use of `process.binding()` by userland code is unsupported.

<a id="DEP0112"></a>
### DEP0112: dgram private APIs

Type: Runtime

The `dgram` module previously contained several APIs that were never meant to
accessed outside of Node.js core: `Socket.prototype._handle`,
`Socket.prototype._receiving`, `Socket.prototype._bindState`,
`Socket.prototype._queue`, `Socket.prototype._reuseAddr`,
`Socket.prototype._healthCheck()`, `Socket.prototype._stopReceiving()`, and
`dgram._createSocketHandle()`.

[`--pending-deprecation`]: cli.html#cli_pending_deprecation
[`Buffer.allocUnsafeSlow(size)`]: buffer.html#buffer_class_method_buffer_allocunsafeslow_size
[`Buffer.from(array)`]: buffer.html#buffer_class_method_buffer_from_array
Expand Down
56 changes: 30 additions & 26 deletions lib/dgram.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -737,65 +737,65 @@ Socket.prototype.getSendBufferSize = function() {
};


// Legacy private APIs to be deprecated in the future.
// Deprecated private APIs.
Object.defineProperty(Socket.prototype, '_handle', {
get() {
get: util.deprecate(function() {
return this[kStateSymbol].handle;
},
set(val) {
}, 'Socket.prototype._handle is deprecated', 'DEP0112'),
set: util.deprecate(function(val) {
this[kStateSymbol].handle = val;
}
}, 'Socket.prototype._handle is deprecated', 'DEP0112')
});


Object.defineProperty(Socket.prototype, '_receiving', {
get() {
get: util.deprecate(function() {
return this[kStateSymbol].receiving;
},
set(val) {
}, 'Socket.prototype._receiving is deprecated', 'DEP0112'),
set: util.deprecate(function(val) {
this[kStateSymbol].receiving = val;
}
}, 'Socket.prototype._receiving is deprecated', 'DEP0112')
});


Object.defineProperty(Socket.prototype, '_bindState', {
get() {
get: util.deprecate(function() {
return this[kStateSymbol].bindState;
},
set(val) {
}, 'Socket.prototype._bindState is deprecated', 'DEP0112'),
set: util.deprecate(function(val) {
this[kStateSymbol].bindState = val;
}
}, 'Socket.prototype._bindState is deprecated', 'DEP0112')
});


Object.defineProperty(Socket.prototype, '_queue', {
get() {
get: util.deprecate(function() {
return this[kStateSymbol].queue;
},
set(val) {
}, 'Socket.prototype._queue is deprecated', 'DEP0112'),
set: util.deprecate(function(val) {
this[kStateSymbol].queue = val;
}
}, 'Socket.prototype._queue is deprecated', 'DEP0112')
});


Object.defineProperty(Socket.prototype, '_reuseAddr', {
get() {
get: util.deprecate(function() {
return this[kStateSymbol].reuseAddr;
},
set(val) {
}, 'Socket.prototype._reuseAddr is deprecated', 'DEP0112'),
set: util.deprecate(function(val) {
this[kStateSymbol].reuseAddr = val;
}
}, 'Socket.prototype._reuseAddr is deprecated', 'DEP0112')
});


Socket.prototype._healthCheck = function() {
Socket.prototype._healthCheck = util.deprecate(function() {
healthCheck(this);
};
}, 'Socket.prototype._healthCheck() is deprecated', 'DEP0112');


Socket.prototype._stopReceiving = function() {
Socket.prototype._stopReceiving = util.deprecate(function() {
stopReceiving(this);
};
}, 'Socket.prototype._stopReceiving() is deprecated', 'DEP0112');


// Legacy alias on the C++ wrapper object. This is not public API, so we may
Expand All @@ -807,7 +807,11 @@ Object.defineProperty(UDP.prototype, 'owner', {


module.exports = {
_createSocketHandle,
_createSocketHandle: util.deprecate(
_createSocketHandle,
'dgram._createSocketHandle() is deprecated',
'DEP0112'
),
createSocket,
Socket
};