Skip to content

doc: make socket IPC examples more robust - #13196

Merged
cjihrig merged 1 commit into
nodejs:masterfrom
cjihrig:docs
Jun 22, 2017
Merged

doc: make socket IPC examples more robust#13196
cjihrig merged 1 commit into
nodejs:masterfrom
cjihrig:docs

Conversation

@cjihrig

Copy link
Copy Markdown
Contributor

This commit aims to improve the documentation examples that send sockets over IPC channels. Specifically, pauseOnConnect is added to a server that inspects the socket before sending and a
'message' handler adds a check that the socket still exists.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

R= @santigimeno

@cjihrig
cjihrig requested a review from santigimenoMay 24, 2017 15:04
@nodejs-github-botnodejs-github-bot added child_process Issues and PRs related to the child_process subsystem. doc Issues and PRs related to the documentations. labels May 24, 2017

@santigimenosantigimeno left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM with a suggestion

Comment threaddoc/api/child_process.md Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe a note why using pauseOnConnect: true is a good practice.

Comment threaddoc/api/child_process.md Outdated

@lpincalpincaMay 24, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nit: is that repeated on purpose?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I wouldn't think so.

@addaleax

Copy link
Copy Markdown
Member

@cjihrig This would need a rebase :)

@cjihrig

Copy link
Copy Markdown
ContributorAuthor

Rebased and addressed comments.

CI: https://ci.nodejs.org/job/node-test-pull-request/8805/

This commit aims to improve the documentation examples that send
sockets over IPC channels. Specifically, pauseOnConnect is added
to a server that inspects the socket before sending and a
'message' handler adds a check that the socket still exists.
PR-URL: nodejs#13196
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
@cjihrig
cjihrig merged commit c02dcc7 into nodejs:masterJun 22, 2017
@cjihrig
cjihrig deleted the docs branch June 22, 2017 20:57
@addaleaxaddaleax mentioned this pull request Jun 24, 2017
addaleax pushed a commit that referenced this pull request Jun 24, 2017
This commit aims to improve the documentation examples that send
sockets over IPC channels. Specifically, pauseOnConnect is added
to a server that inspects the socket before sending and a
'message' handler adds a check that the socket still exists.
PR-URL: #13196
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
@addaleaxaddaleax mentioned this pull request Jun 24, 2017
@MylesBorins

Copy link
Copy Markdown
Contributor

Is this applicable to v6.x?

@MylesBorins

Copy link
Copy Markdown
Contributor

ping @cjihrig

@cjihrig

Copy link
Copy Markdown
ContributorAuthor

Yes, I'd say it's applicable.

@MylesBorins

Copy link
Copy Markdown
Contributor

@cjihrig do you have time to backport?

@cjihrig

Copy link
Copy Markdown
ContributorAuthor

Backport in #15482

MylesBorins pushed a commit that referenced this pull request Oct 16, 2017
This commit aims to improve the documentation examples that send
sockets over IPC channels. Specifically, pauseOnConnect is added
to a server that inspects the socket before sending and a
'message' handler adds a check that the socket still exists.
PR-URL: #13196
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
@MylesBorinsMylesBorins mentioned this pull request Oct 17, 2017
MylesBorins pushed a commit that referenced this pull request Oct 25, 2017
This commit aims to improve the documentation examples that send
sockets over IPC channels. Specifically, pauseOnConnect is added
to a server that inspects the socket before sending and a
'message' handler adds a check that the socket still exists.
PR-URL: #13196
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
@MylesBorinsMylesBorins mentioned this pull request Nov 3, 2017
abhishekumar-tyagi pushed a commit to abhishekumar-tyagi/node that referenced this pull request May 5, 2024
This commit aims to improve the documentation examples that send
sockets over IPC channels. Specifically, pauseOnConnect is added
to a server that inspects the socket before sending and a
'message' handler adds a check that the socket still exists.
PR-URL: nodejs/node#13196
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

child_processIssues and PRs related to the child_process subsystem.docIssues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@cjihrig@addaleax@MylesBorins@mscdex@refack@santigimeno@lpinca@nodejs-github-bot