doc: describe process API for IPC #1978

sam-github · 2015-06-15T02:07:53Z

thefourtheye · 2015-06-15T02:52:56Z

doc/api/process.markdown

+
+When node is spawned with an IPC channel attached, it can send messages to it's
+parent process using `process.send()`. They will be received as a
+['message'](child_process.html#child_process_event_message)


nit: They will be received as messages rather than They will be received as a message

@thefourtheye backticks aren't supported there, the markdown syntax I used is consistent with other places in docs where events are linked to.

@Trott thanks for all the comments, I will incorporate

thefourtheye · 2015-07-10T21:29:35Z

@sam-github Did you get a chance to address the review comments?

sam-github · 2015-07-18T03:38:45Z

comments addressed, @thefourtheye @Trott

sam-github · 2015-07-28T04:14:21Z

@nodejs/collaborators ping, docs for otherwise undocumented node APIs, can I get a thumbs up?

thefourtheye · 2015-07-28T04:46:32Z

doc/api/process.markdown

+
+When node is spawned with an IPC channel attached, it can send messages to its
+parent process using `process.send()`. Each will be received as a
+['message'](child_process.html#child_process_event_message)


Documentation references should be in this format I think [text][] and then at the bottom of the page, [text]: relative url. PTAL at #2142 for reference.

Why? There are over a hundred examples in the API docs of the markup above, including one to this specific event.

Separating out to a ref at the bottom is useful when there are multiple uses made of that ref, otherwise I don't see the point.

If there is a stylistic or technical reason to change all markdown refs to the format you used in #2142, writing a tool to convert them all would be a good way, but that is out of scope here.

Oh okay. Actually I received a comment in that PR, so I thought that that is the standard which we follow.

@thefourtheye the comment on #2142 was from me. It wasn't about having the link at the bottom of the page, just that the URL needed to be relative (without the https://iojs.org/api/ part). It is fine to have it inline.

@targos Ah, I see it now. Thanks for clarifying man :-) @sam-github Sorry about that comment, please ignore it.

No problem, thanks for your attention.

silverwind · 2015-07-28T06:32:00Z

Maybe a small italized disclaimer like *{Method,Event} applies to child processes only.* would be appropriate after the description of each?

sam-github · 2015-07-28T18:27:10Z

@silverwind There is a disclaimer:

If io.js was not spawned with an IPC channel, process.{send, disconnect}() will be undefined.

How would you suggest this be enhanced? Italics around it the entire sentence? "spawned" changed to "spawned as a child process"? You can't get spawned as anything but a child process, so that seems oddly worded to me, but YMMV.

I'm happy to patch in any specific wording or markup to get this wrapped up.

sam-github · 2015-08-06T20:28:00Z

@nodejs/collaborators this is stalled, can I get a review?

cjihrig · 2015-08-06T20:42:55Z

doc/api/process.markdown

+When io.js is spawned with an IPC channel attached, it can send messages to its
+parent process using `process.send()`. Each will be received as a
+['message'](child_process.html#child_process_event_message)
+event on the parent's ChildProcess object.


ChildProcess should probably be in backticks.

cjihrig · 2015-08-06T20:44:54Z

LGTM minus my comments.

Fishrock123 · 2015-08-25T16:35:42Z

ping @sam-github

sam-github · 2015-09-05T00:39:16Z

I'll have time to try the new merge job this weekend, not enough network ATM.

Fishrock123 · 2015-09-05T01:21:57Z

@sam-github We've suspended using that for now. It wasn't working out to well at the current time.

rvagg · 2015-09-07T10:51:20Z

doc/api/process.markdown

@@ -903,6 +913,38 @@ a diff reading, useful for benchmarks and measuring intervals:
    }, 1000);


+## process.send(message[, sendHandle])


as of 607aa3a this should be process.send(message[, sendHandle][, callback]) I believe

bnoordhuis · 2015-09-08T10:44:48Z

doc/api/child_process.markdown

@@ -86,7 +86,7 @@ and the `.connected` property is false.
 ### Event: 'message'

 * `message` {Object} a parsed JSON object or primitive value
-* `sendHandle` {Handle object} a Socket or Server object
+* `sendHandle` {Handle object} a Socket or Server object, or undefined


Suggestion: write as net.Socket and net.Server and make them links to the appropriate sections in net.markdown. Ditto in process.markdown.

bnoordhuis · 2015-09-08T10:49:29Z

LGTM with suggestions.

sam-github · 2015-09-09T16:44:54Z

@bnoordhuis OK, I also found that when you added the callback it invalidated some refs to child.send() because the anchor link changed. @cjihrig you were working on a link checker, weren't you, how's that going?

Reviewed-By: Ben Noordhuis <[email protected]> PR-URL: nodejs#1978

cjihrig · 2015-09-09T16:50:02Z

@cjihrig you were working on a link checker, weren't you, how's that going?

That wasn't me. Maybe @chrisdickinson? A lot of people seem to confuse us.

AndreasMadsen · 2015-09-09T20:08:12Z

dgram.Socket (from dgram.createServer()) is also supported.

Fishrock123 · 2015-09-10T07:51:02Z

\o/

Reviewed-By: Ben Noordhuis <[email protected]> PR-URL: #1978

tflanagan · 2015-09-13T14:34:59Z

Should references to "io.js" be replaced with "node.js"? I found 2 in a quick scan of these changes.

cjihrig · 2015-09-13T14:46:43Z

Yes. Would you care to make a PR @tflanagan

tflanagan · 2015-09-13T15:11:13Z

#2846

mscdex added doc Issues and PRs related to the documentations. process Issues and PRs related to the process subsystem. labels Jun 15, 2015

thefourtheye reviewed Jun 15, 2015
View reviewed changes

rvagg force-pushed the master branch from 9d21135 to 628a3ab Compare June 25, 2015 09:18

sam-github force-pushed the doc-process-ipc branch from 95f7e5a to 6788a84 Compare July 18, 2015 03:37

indutny force-pushed the master branch from bffb204 to eb35968 Compare July 22, 2015 21:21

thefourtheye reviewed Jul 28, 2015
View reviewed changes

targos mentioned this pull request Jul 29, 2015

process.send is not documented #2268

Closed

sam-github force-pushed the doc-process-ipc branch from 6788a84 to 28a75ae Compare August 6, 2015 20:24

cjihrig reviewed Aug 6, 2015
View reviewed changes

sam-github force-pushed the doc-process-ipc branch from e61c07a to a1aa852 Compare September 5, 2015 00:38

rvagg force-pushed the master branch from 11c25c2 to ba02bd0 Compare September 6, 2015 11:55

Fishrock123 mentioned this pull request Sep 7, 2015

Release proposal: v4.0.0 #2715

Merged

rvagg reviewed Sep 7, 2015
View reviewed changes

bnoordhuis reviewed Sep 8, 2015
View reviewed changes

sam-github force-pushed the doc-process-ipc branch 2 times, most recently from 204d0b5 to 92e55ff Compare September 9, 2015 16:42

doc: describe process API for IPC

f442904

Reviewed-By: Ben Noordhuis <[email protected]> PR-URL: nodejs#1978

sam-github force-pushed the doc-process-ipc branch from 92e55ff to f442904 Compare September 9, 2015 16:48

sam-github merged commit f442904 into nodejs:master Sep 9, 2015

sam-github deleted the doc-process-ipc branch September 9, 2015 16:49

sam-github added a commit that referenced this pull request Sep 11, 2015

doc: describe process API for IPC

432cce6

Reviewed-By: Ben Noordhuis <[email protected]> PR-URL: #1978

rvagg mentioned this pull request Sep 12, 2015

Release proposal: v3.3.1 #2698

Merged

Fishrock123 mentioned this pull request Sep 13, 2015

Release proposal: v4.1.0 #2844

Closed

7 tasks

rvagg mentioned this pull request Sep 22, 2015

Release proposal: v4.1.1 #2995

Merged

This was referenced Apr 24, 2023

[Snyk] Fix for 13 vulnerabilities aliscco/alisco-node#112

Open

[Snyk] Fix for 5 vulnerabilities aliscco/alisco-node#348

Open

This was referenced Jun 21, 2023

[Snyk] Fix for 1 vulnerabilities aliscco/alisco-node#477

Open

[Snyk] Fix for 1 vulnerabilities aliscco/alisco-node#487

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: describe process API for IPC #1978

doc: describe process API for IPC #1978

sam-github commented Jun 15, 2015

thefourtheye Jun 15, 2015

Trott Jun 15, 2015

sam-github Jun 15, 2015

thefourtheye commented Jul 10, 2015

sam-github commented Jul 18, 2015

sam-github commented Jul 28, 2015

thefourtheye Jul 28, 2015

sam-github Jul 28, 2015

thefourtheye Jul 28, 2015

targos Jul 28, 2015

thefourtheye Jul 28, 2015

sam-github Jul 28, 2015

silverwind commented Jul 28, 2015

sam-github commented Jul 28, 2015

sam-github commented Aug 6, 2015

cjihrig Aug 6, 2015

cjihrig commented Aug 6, 2015

Fishrock123 commented Aug 25, 2015

sam-github commented Sep 5, 2015

Fishrock123 commented Sep 5, 2015

rvagg Sep 7, 2015

bnoordhuis Sep 8, 2015

bnoordhuis commented Sep 8, 2015

sam-github commented Sep 9, 2015

cjihrig commented Sep 9, 2015

AndreasMadsen commented Sep 9, 2015

Fishrock123 commented Sep 10, 2015

tflanagan commented Sep 13, 2015

cjihrig commented Sep 13, 2015

tflanagan commented Sep 13, 2015

		@@ -903,6 +913,38 @@ a diff reading, useful for benchmarks and measuring intervals:
		}, 1000);


		## process.send(message[, sendHandle])

doc: describe process API for IPC #1978

doc: describe process API for IPC #1978

Conversation

sam-github commented Jun 15, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thefourtheye commented Jul 10, 2015

sam-github commented Jul 18, 2015

sam-github commented Jul 28, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

silverwind commented Jul 28, 2015

sam-github commented Jul 28, 2015

sam-github commented Aug 6, 2015

Choose a reason for hiding this comment

cjihrig commented Aug 6, 2015

Fishrock123 commented Aug 25, 2015

sam-github commented Sep 5, 2015

Fishrock123 commented Sep 5, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bnoordhuis commented Sep 8, 2015

sam-github commented Sep 9, 2015

cjihrig commented Sep 9, 2015

AndreasMadsen commented Sep 9, 2015

Fishrock123 commented Sep 10, 2015

tflanagan commented Sep 13, 2015

cjihrig commented Sep 13, 2015

tflanagan commented Sep 13, 2015