Skip to content

Commit 3da057f

Browse files
chrisdickinsonrvagg
authored andcommitted
dgram: make send cb act as "error" event handler
This allows users to provide a callback that handles potential errors resulting from a `socket.send` call. The original behavior of emitting the error event on the socket is preserved. Fixes: nodejs/node-v0.x-archive#4846 PR-URL: nodejs/node-v0.x-archive#7738 PR-URL: #1796 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
1 parent 3b021ef commit 3da057f

File tree

3 files changed

+66
-2
lines changed

3 files changed

+66
-2
lines changed

doc/api/dgram.markdown

+3-1
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,9 @@ assigned a random port number and is bound to the "all interfaces" address
114114
An optional callback may be specified to detect DNS errors or for determining
115115
when it's safe to reuse the `buf` object. Note that DNS lookups delay the time
116116
to send for at least one tick. The only way to know for sure that the datagram
117-
has been sent is by using a callback.
117+
has been sent is by using a callback. If an error occurs and a callback is given,
118+
the error will be the first argument to the callback. If a callback is not given,
119+
the error is emitted as an `'error'` event on the `socket` object.
118120

119121
With consideration for multi-byte characters, `offset` and `length` will
120122
be calculated with respect to

lib/dgram.js

+9-1
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,15 @@ Socket.prototype.send = function(buffer,
300300

301301
self._handle.lookup(address, function(ex, ip) {
302302
if (ex) {
303-
if (callback) callback(ex);
303+
if (callback) {
304+
callback(ex);
305+
306+
if (self.listeners('error').length)
307+
self.emit('error', ex);
308+
309+
return;
310+
}
311+
304312
self.emit('error', ex);
305313
} else if (self._handle) {
306314
var req = new SendWrap();
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
// Copyright Joyent, Inc. and other Node contributors.
2+
//
3+
// Permission is hereby granted, free of charge, to any person obtaining a
4+
// copy of this software and associated documentation files (the
5+
// "Software"), to deal in the Software without restriction, including
6+
// without limitation the rights to use, copy, modify, merge, publish,
7+
// distribute, sublicense, and/or sell copies of the Software, and to permit
8+
// persons to whom the Software is furnished to do so, subject to the
9+
// following conditions:
10+
//
11+
// The above copyright notice and this permission notice shall be included
12+
// in all copies or substantial portions of the Software.
13+
//
14+
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15+
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16+
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
17+
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18+
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
19+
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20+
// USE OR OTHER DEALINGS IN THE SOFTWARE.
21+
22+
var common = require('../common');
23+
var assert = require('assert');
24+
var dgram = require('dgram');
25+
var dns = require('dns');
26+
27+
var socket = dgram.createSocket('udp4');
28+
var buffer = new Buffer('gary busey');
29+
var times = 0;
30+
31+
dns.setServers([]);
32+
33+
// assert that:
34+
// * callbacks act as "error" listeners if given.
35+
// * callbacks and error events are emitted in a certain order.
36+
socket.send(buffer, 0, buffer.length, 100, 'dne.example.com', callbackOnly);
37+
38+
function callbackOnly(err) {
39+
assert.ok(err);
40+
socket.once('error', onEvent);
41+
socket.send(buffer, 0, buffer.length, 100, 'dne.example.com', onCallback);
42+
}
43+
44+
function onEvent(err) {
45+
assert.ok(err);
46+
assert.equal(times, 0);
47+
times++;
48+
}
49+
50+
function onCallback(err) {
51+
assert.ok(err);
52+
assert.equal(times, 1);
53+
socket.close();
54+
}

0 commit comments

Comments
 (0)