doc: clarify QUIC stream state wording#63660
Open
EduardF1 wants to merge 1 commit into
Open
Conversation
Collaborator
|
Review requested:
|
nodejs-github-bot
added
doc
EduardF1
force-pushed
the
fix/quic-doc-wording
branch
from
478cae7 to
a9a4f4e
Compare
EduardF1
changed the title
EduardF1
force-pushed
the
fix/quic-doc-wording
branch
from
a9a4f4e to
6f7ce01
Compare
…ted, no FIN is sent immediately and the writable side remains open. Describing that state as "half-closed" (or, for unidirectional streams, "closed immediately") is therefore misleading. Update both `createBidirectionalStream()` and `createUnidirectionalStream()` to describe the stream as half-open and explicitly note that no FIN is sent immediately. Fixes nodejs#63655 Signed-off-by: Eduard Fischer-Szava <fischer_eduard@yahoo.com>
Author
|
Friendly ping — just checking in on this documentation clarification. Happy to make any changes if needed! |
metcoder95
approved these changes
Jun 4, 2026
Member
|
Note that half-open and half-closed generally have different meanings in networking. Half-open is a failure case, implying one side has crashed or broken somehow. Half-closed implies one side was explicitly/intentionally closed, but the other remains open for listening, this exact scenario. |
Author
|
Hi @Qard, thank you for the feedback on the terminology. You make a great point regarding 'half-open' implying a failure state in networking contexts vs 'half-closed' implying intentional closure of one stream direction. I will update the documentation to explicitly use 'half-closed' instead to avoid any ambiguity. |
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
4 participants
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.
Summary
createBidirectionalStream()without a body as half-open instead of half-closedcreateUnidirectionalStream()bodydoes not send a FIN immediatelyFixes #63655
Validation
node tools/lint-md/lint-md.mjs doc/api/quic.md