doc: dgram: document bind() callback argument
authorBen Noordhuis <info@bnoordhuis.nl>
Thu, 7 Mar 2013 13:10:47 +0000 (14:10 +0100)
committerBen Noordhuis <info@bnoordhuis.nl>
Thu, 7 Mar 2013 13:11:46 +0000 (14:11 +0100)
doc/api/dgram.markdown

index 2c52c5612ea968f307df98d7ddb6dcf792dda0bd..bcc3dcae5bbb41f9a22ea1c5b563f97463eed833 100644 (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: