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.

Sign up for GitHub

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

Jump to bottom

doc: Clarify support for allowHalfOpen option for IPC connections #38307

Closed
jbriales opened this issue Apr 20, 2021 · 0 comments
Closed

doc: Clarify support for allowHalfOpen option for IPC connections #38307

jbriales opened this issue Apr 20, 2021 · 0 comments
Labels
doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem.

Comments

@jbriales
Copy link

jbriales commented Apr 20, 2021 •
edited
Loading

📗 API Reference Docs Problem

  • Version: v15.11.0
  • Subsystem: net

Location

Section of the site where the content exists

Affected URL(s):

Description

Concise explanation of the problem

The documentation on allowHalfOpen states:

Indicates whether half-opened TCP connections are allowed.

It explicitly mentions TCP, but I tried on an IPC connection with Unix Domain Socket and the option also seems to work as expected.
Should the doc be updated to either drop the explicit TCP mention or clarify expectations wrt IPC connections?
@jbriales jbriales added the doc Issues and PRs related to the documentations. label Apr 20, 2021
@Ayase-252 Ayase-252 added the net Issues and PRs related to the net subsystem. label Apr 20, 2021
lpinca added a commit to lpinca/node that referenced this issue Apr 22, 2021
@lpinca
doc: do not mention TCP in the allowHalfOpen option documentation
5f86e3e 
The `allowHalfOpen` option works in the same way for both TCP and IPC
connections.

Fixes: nodejs#38307
@lpinca lpinca mentioned this issue Apr 22, 2021
Closed
lpinca added a commit to lpinca/node that referenced this issue Apr 22, 2021
@lpinca
doc: do not mention TCP in the allowHalfOpen option description
825e97d 
The `allowHalfOpen` option works in the same way for both TCP and IPC
connections.

Fixes: nodejs#38307
@lpinca lpinca closed this as completed in d432386 Apr 27, 2021
targos pushed a commit that referenced this issue Apr 29, 2021
@lpinca @targos
doc: do not mention TCP in the allowHalfOpen option description
ed5ef21 
The `allowHalfOpen` option works in the same way for both TCP and IPC
connections.

PR-URL: #38360
Fixes: #38307
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
targos pushed a commit that referenced this issue May 30, 2021
@lpinca @targos
doc: do not mention TCP in the allowHalfOpen option description
5229247 
The `allowHalfOpen` option works in the same way for both TCP and IPC
connections.

PR-URL: #38360
Fixes: #38307
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
targos pushed a commit that referenced this issue Jun 5, 2021
@lpinca @targos
doc: do not mention TCP in the allowHalfOpen option description
8f589da 
The `allowHalfOpen` option works in the same way for both TCP and IPC
connections.

PR-URL: #38360
Fixes: #38307
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
targos pushed a commit that referenced this issue Jun 5, 2021
@lpinca @targos
doc: do not mention TCP in the allowHalfOpen option description
8f6570b 
The `allowHalfOpen` option works in the same way for both TCP and IPC
connections.

PR-URL: #38360
Fixes: #38307
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
targos pushed a commit that referenced this issue Jun 11, 2021
@lpinca @targos
doc: do not mention TCP in the allowHalfOpen option description
dcdbaff 
The `allowHalfOpen` option works in the same way for both TCP and IPC
connections.

PR-URL: #38360
Fixes: #38307
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: do not mention TCP in the allowHalfOpen option description lpinca/node
2 participants
@Ayase-252 @jbriales