doc: mention errors thrown by methods called on an unbound dgram.Socket - #33983
Closed
mkrawczuk wants to merge 3 commits into
Closed
doc: mention errors thrown by methods called on an unbound dgram.Socket#33983mkrawczuk wants to merge 3 commits into
mkrawczuk wants to merge 3 commits into
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
addaleax
approved these changes
Jun 20, 2020
addaleax
left a comment
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
I agree, the error system is very inconsistent here, unfortunately … 😕 Thanks for the PR!
Sorry, something went wrong.
Trott
reviewed
Jun 20, 2020
Comment thread
doc/api/dgram.md
Outdated
Trott
reviewed
Jun 20, 2020
Comment thread
doc/api/dgram.md
Outdated
Trott
reviewed
Jun 20, 2020
Comment thread
doc/api/dgram.md
Outdated
Trott
reviewed
Jun 20, 2020
Comment thread
doc/api/dgram.md
Outdated
Trott
approved these changes
Jun 20, 2020
Trott
approved these changes
Jun 20, 2020
Copy link
Copy Markdown
Member
|
The text is fine as is, but if you want to fine-tune it even more, here's one more optional suggestion: Instead of it, I think this method would have been a little better? So "...this method will implicitly bind..." and "This method throws EWHATEVER..." and so forth. |
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
Author
|
Yeah, let's not be satisfied with 99% correct if we can be 100% correct with almost no effort. |
Sorry, something went wrong.
trivikr
approved these changes
Jun 22, 2020
jasnell
reviewed
Jun 22, 2020
Comment thread
doc/api/dgram.md
jasnell
approved these changes
Jun 22, 2020
Trott
pushed a commit
that referenced
this pull request
Jun 24, 2020
PR-URL: #33983 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Jul 14, 2020
PR-URL: #33983 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Jul 16, 2020
PR-URL: #33983 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
addaleax
pushed a commit
that referenced
this pull request
Sep 22, 2020
PR-URL: #33983 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Merged
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
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.
While working on this I have discovered an inconsistency: given dgram.Socket instance is undbound, calling address() on it results in a system error EBADF being thrown, while calling remoteAddress() results in ERR_SOCKET_DGRAM_NOT_CONNECTED.
Also, calling send() on an unbound socket throws ERR_SOCKET_BAD_PORT which might also be found misguiding.
These I believe are easy fixes. Once the documentation resembles the current state of things I can open another PR introducing a fix to it.
Also mentioned a side effect caused by socket.addMembership() and socket.addSourceSpecificMembership(). Not sure if it is desired.