Skip to content

Commit 44cdf96

Browse files
committed
typos and clarity
1 parent ea449f3 commit 44cdf96

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

Protocol.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Key words used by this document conform to the meanings in [RFC 2119](https://to
77
* __Frame__: A frame of data containing a request or a response.
88
* __Transport__: Protocol used to carry ReactiveSockets protocol. Such as WebSockets, TCP, Aeron, etc.
99
* __Stream__: Unit of operation (request/response, etc.). See [Design Principles](DesignPrinciples.md).
10-
* __Request__: A stream request. May be one of four types.
11-
* __Response__: A stream response. Comprised of 1 or more headers chained together that contain data, control, and metadata.
12-
* __Client__: The side connecting to a server.
10+
* __Request__: A stream request. May be one of four types. As well as request for more items or cancellation of previous request.
11+
* __Response__: A stream response. Contains data associated with previous request.
12+
* __Client__: The side connecting to a server. i.e. initiating a connection.
1313
* __Server__: The side accepting connections from clients.
1414
* __Connection__: The instance of a transport session between client and server.
1515
* __Requester__: The side sending a request. A connection has at most 2 Requesters. One in each direction.
@@ -337,9 +337,9 @@ that SETUP (accept it) or not (reject it).
337337

338338
## Fragmentation And Reassembly
339339

340-
RESPONSE frames with NEXT headers may respresent a large object and MAY need to be fragmented to fit within the Header Data size. When this
341-
occurs, the NEXT headers Begin and End bits must be used to indicate a begin fragment and an end fragment. Or, when
342-
both bits set, the contents represent a complete NEXT header.
340+
RESPONSE frames may respresent a large object and MAY need to be fragmented to fit within the Frame Data size. When this
341+
occurs, the RESPONSE Begin and End bits must be used to indicate a begin fragment and an end fragment. Or, when
342+
both bits set, the contents represent a reassembled RESPONSE.
343343

344344
## Stream Sequences and Lifetimes
345345

@@ -466,10 +466,11 @@ Upon sending a ERROR, the stream is terminated on the Responder.
466466
### TODO
467467

468468
1. REQUEST_N needs to return point in stream in some way. Or even a new header type REQUEST_N_POSITIONED, or POSITION header, e.g.
469-
* object (NEXT) counter
469+
* object (NEXT) counter kept as Requester stat for the stream
470470
1. Connection instance
471471
* Requester instance
472472
* Responder instance
473-
1. Exlicit METADATA header needed?
474-
* need metadata semantics
473+
1. Exlicit METADATA needed?
474+
* need to understand metadata semantics
475+
* could be flag or explicit frame type or if needed to be attached to specific NEXT, could be option header
475476
1. Handling the unexpected questions

0 commit comments

Comments
 (0)