From 924f603e26b450d83234781e80de95d76fcf251a Mon Sep 17 00:00:00 2001 From: Ben Noordhuis Date: Thu, 7 Mar 2013 14:10:47 +0100 Subject: [PATCH] doc: dgram: document bind() callback argument --- doc/api/dgram.markdown | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/doc/api/dgram.markdown b/doc/api/dgram.markdown index 2c52c5612ea..bcc3dcae5bb 100644 --- a/doc/api/dgram.markdown +++ b/doc/api/dgram.markdown @@ -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: