Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: do not mention TCP in the allowHalfOpen option description #38360

Closed
wants to merge 2 commits into from

Conversation

lpinca
Copy link
Member

@lpinca lpinca commented Apr 22, 2021

The allowHalfOpen option works in the same way for both TCP and IPC
connections.

Fixes: #38307

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Apr 22, 2021
The `allowHalfOpen` option works in the same way for both TCP and IPC
connections.

Fixes: nodejs#38307
@lpinca lpinca changed the title doc: do not mention TCP in the allowHalfOpen option documentation doc: do not mention TCP in the allowHalfOpen option description Apr 22, 2021
doc/api/net.md Outdated
Comment on lines 554 to 555
* `allowHalfOpen` {boolean} Indicates whether to automatically end the
writable side when the readable side ends. See [`net.createServer()`][] and
Copy link
Member

Choose a reason for hiding this comment

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

Does this make it sound like you should set it to true to automatically end the writable side when in fact the opposite is true?

Copy link
Member Author

@lpinca lpinca Apr 24, 2021

Choose a reason for hiding this comment

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

  1. Indicates whether to not automatically end the writable side when the readable side ends.
  2. Indicates whether to keep the writable side open when the readable side ends.
  3. Other suggestions?

Copy link
Member Author

@lpinca lpinca Apr 24, 2021

Choose a reason for hiding this comment

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

PTAL, I've used the same wording used here https://nodejs.org/api/stream.html#stream_new_stream_duplex_options.

lpinca added a commit that referenced this pull request Apr 27, 2021
The `allowHalfOpen` option works in the same way for both TCP and IPC
connections.

PR-URL: #38360
Fixes: #38307
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
@lpinca
Copy link
Member Author

lpinca commented Apr 27, 2021

Landed in d432386.

@lpinca lpinca closed this Apr 27, 2021
@lpinca lpinca deleted the fix/issue-38307 branch April 27, 2021 17:22
targos pushed a commit that referenced this pull request Apr 29, 2021
The `allowHalfOpen` option works in the same way for both TCP and IPC
connections.

PR-URL: #38360
Fixes: #38307
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
@targos targos mentioned this pull request May 3, 2021
targos pushed a commit that referenced this pull request May 30, 2021
The `allowHalfOpen` option works in the same way for both TCP and IPC
connections.

PR-URL: #38360
Fixes: #38307
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
targos pushed a commit that referenced this pull request Jun 5, 2021
The `allowHalfOpen` option works in the same way for both TCP and IPC
connections.

PR-URL: #38360
Fixes: #38307
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
targos pushed a commit that referenced this pull request Jun 5, 2021
The `allowHalfOpen` option works in the same way for both TCP and IPC
connections.

PR-URL: #38360
Fixes: #38307
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
targos pushed a commit that referenced this pull request Jun 11, 2021
The `allowHalfOpen` option works in the same way for both TCP and IPC
connections.

PR-URL: #38360
Fixes: #38307
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc: Clarify support for allowHalfOpen option for IPC connections
6 participants