Consistent event semantics and documentation #73
Merged
Conversation
This file contains hidden or 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
jsor
requested changes
Mar 7, 2017
README.md
Outdated
| In other words, many lower-level protocols (such as TCP/IP) may choose | ||
| to only emit this for a fatal transmission error once and will thus | ||
| likely close (terminate) the stream in response. | ||
| It this is a fatal error that results in the stream being closed, it |
README.md
Outdated
| }); | ||
| ``` | ||
|
|
||
| This event SHOULD be emitted once every time the buffer become full |
README.md
Outdated
|
|
||
| The `pipe` event will be emitted whenever a readable stream is `pipe()`d | ||
| into this stream. | ||
| Event event receives a single `ReadableStreamInterface` argument for the |
README.md
Outdated
| only deal with data transmission and may choose | ||
| to only emit this for a fatal transmission error once and will thus | ||
| likely close (terminate) the stream in response. | ||
| It this is a fatal error that results in the stream being closed, it |
src/ReadableStreamInterface.php
Outdated
| * | ||
| * This event SHOULD be emitted once or never at all, depending on whether | ||
| * the stream ever terminates. | ||
| * It SHOULD NOT be emitted afer a previous `close` event. |
src/WritableStreamInterface.php
Outdated
| * | ||
| * This event SHOULD be emitted once or never at all, depending on whether | ||
| * the stream ever terminates. | ||
| * It SHOULD NOT be emitted afer a previous `close` event. |
README.md
Outdated
|
|
||
| This event SHOULD be emitted once or never at all, depending on whether | ||
| the stream ever terminates. | ||
| It SHOULD NOT be emitted afer a previous `close` event. |
README.md
Outdated
|
|
||
| This event SHOULD be emitted once or never at all, depending on whether | ||
| the stream ever terminates. | ||
| It SHOULD NOT be emitted afer a previous `close` event. |
Member
Author
|
Thanks for spotting these, typos fixed and changes squashed |
jsor
approved these changes
Mar 7, 2017
WyriHaximus
approved these changes
Mar 8, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Et voilà, consistent event semantics and documentation 🎉
This pretty much only adds consistent documentation for what is currently undocumented and implicitly assumed.
This should in fact not break any of the existing assumptions and as such should not be considered a BC break. Given that this current behavior was mostly underdocumented or undocumented, I'll mark this as a BC break just to be safe in case any implementation relies on undocumented features which might now be prohibited.
Builds on top of #72.