add goals to readme #1
Merged
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
jasnell
reviewed
Jan 10, 2018
readme.md
Outdated
| - Buffering of data (for any reason) is done outside of the protocol. | ||
| - (Either between, or at the ends of protocol interaction.) | ||
| - Errors and data should flow through the same call path. | ||
| - Callbacks should be the "EOF" mechanism. |
There was a problem hiding this comment.
Perhaps add...
- Protocol assumes one-to-one relationship between consumer/sink. (specifically rules out eventemitter like model)
- Protocol should make no timing assumptions (echoing the point about the consumer below)
On the point about state, the protocol itself should assume no state between calls. All necessary context should be passed with each call (e.g. using a handle object for context passing).
mcollina
reviewed
Jan 11, 2018
readme.md
Outdated
| - Focused on interaction of protocol endpoints rather than full-stream management. | ||
| - Buffering of data (for any reason) is done outside of the protocol. | ||
| - (Either between, or at the ends of protocol interaction.) | ||
| - Errors and data should flow through the same call path. |
There was a problem hiding this comment.
I would add that this new protocol is "pull only", not push/pull like streams3.
mcollina
reviewed
Jan 11, 2018
|
|
||
| _The name? something something b~~l~~ob, credit Matteo Collina._ | ||
|
|
||
| ## Goals | ||
| Some collective goals for this initiative. |
There was a problem hiding this comment.
I would note that we aim for:
- a very performance C++ implementation
- a very performance JS implementation
- something that it can be easily ported on the browser too
mcollina
reviewed
Jan 11, 2018
readme.md
Outdated
| As a preface, "protocol" refers to a system with "producer / source" and "consumer / sink" endpoints, where the consumer "pulls" from the producer. | ||
|
|
||
| - Protocol and protocol state must be simple, certainly simpler than streams3. | ||
| - Focused on interaction of protocol endpoints rather than full-stream management. |
There was a problem hiding this comment.
JS level to be able to handover completely to C++ if supported.
mcollina
reviewed
Jan 11, 2018
readme.md
Outdated
| @@ -1,9 +1,30 @@ | |||
| # bob | |||
|
|
|||
| A Work-In-Progress "streams" implementation via data sources, data sinks, and pull flow. | |||
| A Work-In-Progress "streams+" implementation via data producers, data consumers, and pull flow. | |||
There was a problem hiding this comment.
I would add that this is binary only.
jasnell
reviewed
Jan 12, 2018
readme.md
Outdated
| - (Either between, or at the ends of protocol interaction.) | ||
| - Errors and data should flow through the same call path. | ||
| - Callbacks should be the "EOF" mechanism. | ||
|
|
There was a problem hiding this comment.
In the spirit of condensing ...
The Protocol must be simple:
* Pull-based: The consumer requests ("pulls") data from the producer.
* Binary-only: Data is binary buffers only, "object mode" and string encodings are not supported at the protocol level
* Stateless: The protocol must not require state to be maintained out-of-band
* One-to-one: The protocol assumes a one-to-one relationship between producer and consumer
* Timing agnostic: The protocol makes no timing (sync or async) assumptions.
* No buffering: The protocol must not require buffering (although specific implementations might)
* In-line errors and EOF: Errors, data, and EOF should flow through the same call path.
|
Sgtm |
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.
@jasnell How does this look?
@mcollina you might want to take a peek as well.
I feel like I'm missing a thing or three, but it's a start.