doc: dgram: add v0.10 bind() behavior note

dgram.Socket#bind() is always asynchronous now. Add a note at the top
of the documentation that explains how to upgrade.

Fixes #4944.
pull/24507/merge
Ben Noordhuis 2013-03-07 14:13:01 +01:00
parent 924f603e26
commit 71694361f9
1 changed files with 15 additions and 0 deletions

View File

@ -6,6 +6,21 @@
Datagram sockets are available through `require('dgram')`.
Important note: the behavior of `dgram.Socket#bind()` has changed in v0.10
and is always asynchronous now. If you have code that looks like this:
var s = dgram.createSocket('udp4');
s.bind(1234);
s.addMembership('224.0.0.114');
You have to change it to this:
var s = dgram.createSocket('udp4');
s.bind(1234, function() {
s.addMembership('224.0.0.114');
});
## dgram.createSocket(type, [callback])
* `type` String. Either 'udp4' or 'udp6'