improves Fragmentation examples #320
Open
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
Signed-off-by: Oleh Dokuka <odokuka@vmware.com>
OlegDokuka
requested review from
rstoyanchev,
benjchristensen,
dnadoba,
linux-china,
nkristek,
SerCeMan,
simonbasle,
smaldini,
spencergibb,
stevegury,
viglucci,
whyoleg and
yschimke
OlegDokuka
changed the title
dnadoba
reviewed
Mar 31, 2021
dnadoba
reviewed
Mar 31, 2021
Co-authored-by: David Nadoba <dnadoba@gmail.com>
nkristek
reviewed
Mar 31, 2021
| Frame length = 16MB | ||
| (M)etadata present = 1 | ||
| (F)ollows = 1 (fragments coming) | ||
| (N)ext = 1 |
There was a problem hiding this comment.
The REQUEST_CHANNEL doesn't have a (N)ext flag: https://rsocket.io/docs/protocol/#request_channel-frame-0x07
rstoyanchev
requested changes
Mar 31, 2021
| @@ -949,11 +949,14 @@ When a PAYLOAD is fragmented, the Metadata MUST be transmitted completely before | |||
|
|
|||
| For example, a single PAYLOAD with 20MB of Metadata and 25MB of Data that is fragmented into 3 frames: | |||
|
|
|||
| ##### Payload with `next` flag set | |||
There was a problem hiding this comment.
I don't think this needs to be a sub-section with a heading, especially coming after a ":". Rather it can be just the first example you see. So basically I suggest removing the sub-heading completely. Then after that, below for the second example, simply add a sentence before it. I'll add a concrete suggestion there.
| @@ -987,6 +1032,8 @@ When fragmented, the Metadata MUST be transmitted completely before the Data. | |||
|
|
|||
| For example, a single PAYLOAD with 20MB of Metadata and 25MB of Data that is fragmented into 3 frames: | |||
|
|
|||
| ##### Request Response | |||
There was a problem hiding this comment.
Similar suggestion here, to remove the sub-headings.
|
|
||
| If the Requester wants to cancel sending a fragmented sequence, it MAY send a CANCEL frame without finishing delivery of the fragments. | ||
|
|
||
| ##### Request Channel with `complete` flag |
There was a problem hiding this comment.
Suggested change
| ##### Request Channel with `complete` flag | |
| Below is an example for Request Channel with the `complete` flag indicating the entire sequence is a `PAYLOAD` with `next` and `complete` both set. |
Co-authored-by: Rossen Stoyanchev <rstoyanchev@users.noreply.github.com>
OlegDokuka
commented
May 25, 2021
| @@ -949,11 +949,14 @@ When a PAYLOAD is fragmented, the Metadata MUST be transmitted completely before | |||
|
|
|||
| For example, a single PAYLOAD with 20MB of Metadata and 25MB of Data that is fragmented into 3 frames: | |||
|
|
|||
| ##### Payload with `next` flag set | |||
|
|
|||
| ``` | |||
There was a problem hiding this comment.
move to a separate doc
Co-authored-by: Rossen Stoyanchev <rstoyanchev@users.noreply.github.com>
Co-authored-by: Rossen Stoyanchev <rstoyanchev@users.noreply.github.com>
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.
Provide better examples for Fragmentation
Motivation:
At the moment, fragmentation examples do not explain in details how every frame (including flags) should look like
Modifications:
This PR adds flags to the example sequences as well as add cases when payload has next and complete flags and adds example for Request Channel which has complete flag
Result:
Improved examples
Signed-off-by: Oleh Dokuka odokuka@vmware.com