Skip to content
This repository was archived by the owner on Apr 22, 2023. It is now read-only.

docs: port is optional for socket.bind() #25356

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions doc/api/dgram.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -156,19 +156,21 @@ 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
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
useful.
`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 listenerand `callback` is not harmful
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

listenerand... might have to re-open this as a new PR, no longer have this fork.

but not very useful.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Specifying both the "listening" event listener and callback


A bound datagram socket keeps the node process running to receive
datagrams.
Expand Down