daohualiuxiang
/
node
mirror of https://github.com/nodejs/node.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: dgram: document bind() callback argument

pull/24507/merge
Ben Noordhuis 2013-03-07 14:10:47 +01:00
parent f780c6f598
commit 924f603e26
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/api/dgram.markdown
View File

@ -108,13 +108,17 @@ a packet might travel, and that generally sending a datagram greater than
the (receiver) `MTU` won't work (the packet gets silently dropped, without
informing the source that the data did not reach its intended recipient).
### dgram.bind(port, [address])
### dgram.bind(port, [address], [callback])
* `port` Integer
* `address` String, Optional
* `callback` Function, Optional
For UDP sockets, listen for datagrams on a named `port` and optional `address`. If
`address` is not specified, the OS will try to listen on all addresses.
For UDP sockets, listen for datagrams on a named `port` and optional `address`.
If `address` is not specified, the OS will try to listen on all addresses.
The `callback` argument, if provided, is added as a one-shot `'listening'`
event listener.
Example of a UDP server listening on port 41234: