From ea9ee15c21301392c6d50d8c3953f905b455667b Mon Sep 17 00:00:00 2001 From: James M Snell Date: Fri, 14 Aug 2015 15:05:24 -0700 Subject: [PATCH] doc: port is optional for socket.bind() per: https://github.com/joyent/node/pull/25356 originally submitted by @dcousens Reviewed By: Sakthipriyan Vairamani PR-URL: https://github.com/nodejs/node/pull/2378 --- doc/api/dgram.markdown | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/api/dgram.markdown b/doc/api/dgram.markdown index 757230492df4ee..6e9f614ed53c6f 100644 --- a/doc/api/dgram.markdown +++ b/doc/api/dgram.markdown @@ -158,15 +158,16 @@ 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). -### socket.bind(port[, address][, callback]) +### socket.bind([port][, address][, callback]) -* `port` Integer +* `port` Integer, Optional * `address` String, Optional * `callback` Function with no parameters, Optional. Callback when binding is done. 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 +`address`. If `port` is not specified, the OS will try to bind to a random +port. If `address` is not specified, the OS will try to listen on all addresses. After binding is done, a "listening" event is emitted and the `callback`(if specified) is called. Specifying both a "listening" event listener and `callback` is not harmful but not very