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

src: document DoWrite() usage expectations #26339

Closed

Conversation

sam-github
Copy link
Contributor

@sam-github sam-github commented Feb 27, 2019

Clarify how it must behave for both synchronous and asynchronous
completion.

@addaleax @nodejs/streams This documents my understanding of the StreamResource::DoWrite() API expectations. TLS wasn't obeying these expecations, leading to wide-spread test suite failures during TLS1.3 development.

Checklist

Clarify how it must behave for both synchronous and asynchronous
completion.
@nodejs-github-bot
Copy link
Collaborator

@sam-github sadly an error occured when I tried to trigger a build :(

@nodejs-github-bot nodejs-github-bot added the c++ Issues and PRs that require attention from people who are familiar with C++. label Feb 27, 2019
@sam-github sam-github added the stream Issues and PRs related to the stream subsystem. label Feb 27, 2019
@sam-github
Copy link
Contributor Author

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

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

LGTM

@sam-github
Copy link
Contributor Author

@addaleax addaleax added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Feb 28, 2019
@sam-github
Copy link
Contributor Author

re-ci: https://ci.nodejs.org/job/node-test-pull-request/21112/ It's just a header file comment, but a good build is hard to find. :-(

@sam-github
Copy link
Contributor Author

re-ci: https://ci.nodejs.org/job/node-test-pull-request/21115/

windows vs2017 failed across the board, looks like remotes couldn't get connected to, but perhaps I misread the log files

@addaleax
Copy link
Member

addaleax commented Mar 2, 2019

@BridgeAR
Copy link
Member

BridgeAR commented Mar 4, 2019

This should not require a full CI run as it's a doc only change. Therefore this should be good to land without making sure all platforms are green.

@sam-github
Copy link
Contributor Author

Landed in 6593f77

@sam-github sam-github closed this Mar 4, 2019
@sam-github sam-github deleted the doc-dowrite-expectations branch March 4, 2019 18:26
sam-github added a commit that referenced this pull request Mar 4, 2019
Clarify how it must behave for both synchronous and asynchronous
completion.

PR-URL: #26339
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
BridgeAR pushed a commit to BridgeAR/node that referenced this pull request Mar 12, 2019
Clarify how it must behave for both synchronous and asynchronous
completion.

PR-URL: nodejs#26339
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. c++ Issues and PRs that require attention from people who are familiar with C++. stream Issues and PRs related to the stream subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants