This repository was archived by the owner on Apr 22, 2023. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 7.3k
docs: port is optional for socket.bind() #25356
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
but not very useful. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Specifying both the "listening" event listener and |
||
|
||
A bound datagram socket keeps the node process running to receive | ||
datagrams. | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.