doc,stream: _transform cannot be called in parallel #14321
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
doc
benjamingr
approved these changes
Jul 17, 2017
Trott
approved these changes
Jul 17, 2017
doc/api/stream.md
Outdated
| @@ -2033,6 +2033,10 @@ The `transform._transform()` method is prefixed with an underscore because it | |||
| is internal to the class that defines it, and should never be called directly by | |||
| user programs. | |||
|
|
|||
| `transform._transform` is never called in parallel: streams implement a | |||
There was a problem hiding this comment.
Nit: _transform -> _transform()
Nit: : -> ;
doc/api/stream.md
Outdated
| @@ -2033,6 +2033,10 @@ The `transform._transform()` method is prefixed with an underscore because it | |||
| is internal to the class that defines it, and should never be called directly by | |||
| user programs. | |||
|
|
|||
| `transform._transform` is never called in parallel: streams implement a | |||
| queue mechanism, and to receive the next chunk `callback` must be | |||
Add a note to the stream docs specifying that at most a single call to _transform can happen, and the provided callback() should be used to process another chunk. Fixes: nodejs#3208
|
@Trott good spot, way better. |
lpinca
approved these changes
Jul 17, 2017
jasnell
reviewed
Jul 17, 2017
| @@ -2033,6 +2033,10 @@ The `transform._transform()` method is prefixed with an underscore because it | |||
| is internal to the class that defines it, and should never be called directly by | |||
| user programs. | |||
|
|
|||
| `transform._transform()` is never called in parallel; streams implement a | |||
There was a problem hiding this comment.
minor nit: extra space here before "parallel"
jasnell
approved these changes
Jul 17, 2017
cjihrig
approved these changes
Jul 17, 2017
|
Landed as 0e5283b |
mcollina
added a commit
that referenced
this pull request
Jul 19, 2017
Add a note to the stream docs specifying that at most a single call to _transform can happen, and the provided callback() should be used to process another chunk. Fixes: #3208 PR-URL: #14321 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
addaleax
pushed a commit
that referenced
this pull request
Jul 22, 2017
Add a note to the stream docs specifying that at most a single call to _transform can happen, and the provided callback() should be used to process another chunk. Fixes: #3208 PR-URL: #14321 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
Fishrock123
pushed a commit
that referenced
this pull request
Jul 24, 2017
Add a note to the stream docs specifying that at most a single call to _transform can happen, and the provided callback() should be used to process another chunk. Fixes: #3208 PR-URL: #14321 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
Closed
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Aug 16, 2017
Add a note to the stream docs specifying that at most a single call to _transform can happen, and the provided callback() should be used to process another chunk. Fixes: #3208 PR-URL: #14321 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
|
@mcollina i landed this on v6.x-staging, lmk if it is incorrect |
|
It's ok. |
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Aug 16, 2017
Add a note to the stream docs specifying that at most a single call to _transform can happen, and the provided callback() should be used to process another chunk. Fixes: #3208 PR-URL: #14321 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
MylesBorins
pushed a commit
that referenced
this pull request
Sep 3, 2017
Add a note to the stream docs specifying that at most a single call to _transform can happen, and the provided callback() should be used to process another chunk. Fixes: #3208 PR-URL: #14321 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
MylesBorins
pushed a commit
that referenced
this pull request
Sep 5, 2017
Add a note to the stream docs specifying that at most a single call to _transform can happen, and the provided callback() should be used to process another chunk. Fixes: #3208 PR-URL: #14321 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
This was referenced Sep 5, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a note to the stream docs specifying that at most a single
call to _transform can happen, and the provided callback()
should be used to process another chunk.
Fixes: #3208
Checklist
Affected core subsystem(s)
doc, stream