Skip to content

Commit

Permalink
doc: port is optional for socket.bind()
Browse files Browse the repository at this point in the history
per: nodejs/node-v0.x-archive#25356

originally submitted by @dcousens

Reviewed By: Sakthipriyan Vairamani <[email protected]>
PR-URL: #2378
  • Loading branch information
jasnell authored and rvagg committed Aug 26, 2015
1 parent 0ff6657 commit ea9ee15
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions doc/api/dgram.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit ea9ee15

Please sign in to comment.