Skip to content

Commit 5917ab9

Browse files
Clarify COMPLETE (rsocket#204)
Clarify language about COMPLETE in the frames with (C)omplete, and in the terminology section.
1 parent 8908e95 commit 5917ab9

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

Protocol.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,9 @@ See [Fragmentation and Reassembly](#fragmentation-and-reassembly).
5353
provide capabilities mentioned in the [transport protocol](#transport-protocol) section.
5454
* __Stream__: Unit of operation (request/response, etc.). See [Motivations](Motivations.md).
5555
* __Request__: A stream request. May be one of four types. As well as request for more items or cancellation of previous request.
56-
* __Payload__: A stream message (upstream or downstream). Contains data associated with a stream created by a previous request.
56+
* __Payload__: A stream message (upstream or downstream). Contains data associated with a stream created by a previous request. In Reactive Streams and Rx this is the 'onNext' event.
57+
* __Complete__: Terminal event sent on a stream to signal successful completion. In Reactive Streams and Rx this is the 'onComplete' event.
58+
* A frame (PAYLOAD or REQUEST_CHANNEL) with the Complete bit set is sometimes referred to as COMPLETE in this document when reference to the frame is semantically about the Complete bit/event.
5759
* __Client__: The side initiating a connection.
5860
* __Server__: The side accepting connections from clients.
5961
* __Connection__: The instance of a transport session between client and server.
@@ -527,7 +529,8 @@ Frame Contents
527529
* __Flags__: (10 bits)
528530
* (__M__)etadata: Metadata present
529531
* (__F__)ollows: More fragments follow this fragment.
530-
* (__C__)omplete: bit to indicate COMPLETE.
532+
* (__C__)omplete: bit to indicate stream completion.
533+
* If set, `onComplete()` or equivalent will be invoked on Subscriber/Observer.
531534
* __Initial Request N__: (31 bits = max value 2^31-1 = 2,147,483,647) Unsigned 31-bit integer representing the initial request N value for channel. Value MUST be > 0.
532535
* __Request Data__: identification of the service being requested along with parameters for the request.
533536

@@ -599,14 +602,12 @@ Frame Contents
599602
* __Flags__: (10 bits)
600603
* (__M__)etadata: Metadata Present.
601604
* (__F__)ollows: More fragments follow this fragment.
602-
* (__C__)omplete: bit to indicate COMPLETE.
605+
* (__C__)omplete: bit to indicate stream completion.
603606
* If set, `onComplete()` or equivalent will be invoked on Subscriber/Observer.
604607
* (__N__)ext: bit to indicate Next (Payload Data and/or Metadata present).
605608
* If set, `onNext(Payload)` or equivalent will be invoked on Subscriber/Observer.
606609
* __Payload Data__: payload for Reactive Streams onNext.
607610

608-
A Payload with the Complete Bit set is referred to as a COMPLETE.
609-
610611
<a name="frame-metadata-push"></a>
611612
### METADATA_PUSH Frame (0x0C)
612613

0 commit comments

Comments
 (0)