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: add backlog for more server.listen variants #4025

Closed
wants to merge 1 commit into from

Conversation

jscissr
Copy link
Contributor

@jscissr jscissr commented Nov 25, 2015

Actually, backlog is even supported for the options variant; but I think this would be too confusing if documented, as the options.backlog property takes precedence.

@mscdex mscdex added doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem. labels Nov 25, 2015
@jasnell
Copy link
Member

jasnell commented Dec 14, 2015

@bnoordhuis @indutny

@@ -102,6 +103,10 @@ This function is asynchronous. When the server has been bound,
The last parameter `callback` will be added as a listener for the
['listening'][] event.

The parameter `backlog` behaves the same as in
Copy link
Contributor

Choose a reason for hiding this comment

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

Any reason you added this explanation here, but not for the other variation?

@cjihrig
Copy link
Contributor

cjihrig commented Dec 14, 2015

LGTM with a question. Glad to get this documented.

@indutny
Copy link
Member

indutny commented Dec 14, 2015

Does this work on windows, though?

@indutny
Copy link
Member

indutny commented Dec 14, 2015

It does! LGTM

Actually, `backlog` is even supported for the `options` variant; but I
think this would be too confusing if documented, as the
`options.backlog` property takes precedence.
@jscissr
Copy link
Contributor Author

jscissr commented Dec 16, 2015

I now added the note for the second variant. I also moved the link into the link definitions.

cjihrig pushed a commit that referenced this pull request Dec 16, 2015
The backlog parameter is supported by all variations of
net.Server.listen(), but wasn't consistently documented. This
commit brings the documentation into a more consistent state.

Refs: #4056
PR-URL: #4025
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Fedor Indutny <[email protected]>
@cjihrig
Copy link
Contributor

cjihrig commented Dec 16, 2015

Thanks! Landed in 9e1b7aa.

@cjihrig cjihrig closed this Dec 16, 2015
cjihrig pushed a commit that referenced this pull request Dec 16, 2015
The backlog parameter is supported by all variations of
net.Server.listen(), but wasn't consistently documented. This
commit brings the documentation into a more consistent state.

Refs: #4056
PR-URL: #4025
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Fedor Indutny <[email protected]>
@rvagg rvagg mentioned this pull request Dec 17, 2015
MylesBorins pushed a commit that referenced this pull request Dec 29, 2015
The backlog parameter is supported by all variations of
net.Server.listen(), but wasn't consistently documented. This
commit brings the documentation into a more consistent state.

Refs: #4056
PR-URL: #4025
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Fedor Indutny <[email protected]>
MylesBorins pushed a commit that referenced this pull request Jan 19, 2016
The backlog parameter is supported by all variations of
net.Server.listen(), but wasn't consistently documented. This
commit brings the documentation into a more consistent state.

Refs: #4056
PR-URL: #4025
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Fedor Indutny <[email protected]>
@MylesBorins MylesBorins mentioned this pull request Jan 19, 2016
scovetta pushed a commit to scovetta/node that referenced this pull request Apr 2, 2016
The backlog parameter is supported by all variations of
net.Server.listen(), but wasn't consistently documented. This
commit brings the documentation into a more consistent state.

Refs: nodejs#4056
PR-URL: nodejs#4025
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Fedor Indutny <[email protected]>
@jscissr jscissr deleted the patch-1 branch August 6, 2016 19:25
This was referenced Mar 22, 2022
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. net Issues and PRs related to the net subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants