doc: Add notes how addMembership should be managed #16240
Closed
Conversation
This file contains 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
nodejs-github-bot
added
dgram
lpinca
reviewed
Oct 17, 2017
doc/api/dgram.md
Outdated
| @@ -95,6 +95,17 @@ Tells the kernel to join a multicast group at the given `multicastAddress` and | |||
| one interface and will add membership to it. To add membership to every | |||
| available interface, call `addMembership` multiple times, once per interface. | |||
|
|
|||
| When the socket is created, each worker gets a copy and they refer the | |||
There was a problem hiding this comment.
Does "worker" refer to a cluster environment? If so I think it makes sense to specify it as the sentence seems to be a bit out of context without it.
There was a problem hiding this comment.
Yes, it does and I agreed on it. I will add the context.
jasnell
reviewed
Oct 18, 2017
doc/api/dgram.md
Outdated
| @@ -95,6 +95,17 @@ Tells the kernel to join a multicast group at the given `multicastAddress` and | |||
| one interface and will add membership to it. To add membership to every | |||
| available interface, call `addMembership` multiple times, once per interface. | |||
|
|
|||
| When the socket is created, each worker gets a copy and they refer the | |||
| same socket so you need to manage to call `.addMembership` only once. | |||
There was a problem hiding this comment.
Please avoid using the informal pronoun you in the docs :-)
There was a problem hiding this comment.
Sure! I will update it.
watilde
force-pushed
the
feature/docs-dgram
branch
from
1c7f640 to
5292a50
Compare
|
@watilde Why did you close this pr? |
|
ping @watilde - what happened here? the changes look reasonable. was it through an error you deleted the branch and closed the PR? are you planning to resurrect this? |
jasnell
added a commit
to jasnell/node
that referenced
this pull request
Oct 19, 2018
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes: #12572
Checklist
Affected core subsystem(s)
doc, dgram