Skip to content

Commit 4cc6e34

Browse files
Remove Metadata from CANCEL & ERROR (rsocket#215)
* Remove Metadata from various frames As per discussion in rsocket/rsocket#201, remove Metadata from ERROR, LEASE, and CANCEL frames. * restore metadata to LEASE * metadata -> error data
1 parent d055299 commit 4cc6e34

File tree

1 file changed

+4
-9
lines changed

1 file changed

+4
-9
lines changed

Protocol.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -316,16 +316,14 @@ Frame Contents
316316
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
317317
| Stream ID |
318318
+-----------+-+-+---------------+-------------------------------+
319-
|Frame Type |0|M| Flags |
319+
|Frame Type |0|0| Flags |
320320
+-----------+-+-+---------------+-------------------------------+
321321
| Error Code |
322322
+---------------------------------------------------------------+
323-
Metadata & Error Data
323+
Error Data
324324
```
325325

326326
* __Frame Type__: (6 bits = max value 63) 0x0B
327-
* __Flags__: (10 bits)
328-
* (__M__)etadata: Metadata present
329327
* __Error Code__: (32 bits = max value 2^31-1 = 2,147,483,647) Type of Error.
330328
* See list of valid Error Codes below.
331329
* __Error Data__: includes Payload describing error information. Error Data SHOULD be a UTF-8 encoded string. The string MUST NOT be null terminated.
@@ -346,7 +344,7 @@ The Error Data is typically an Exception message, but could include stringified
346344
| __CONNECTION_ERROR__ | 0x00000101 | The connection is being terminated. Stream ID MUST be 0. Sender or Receiver of this frame MAY close the connection immediately without waiting for outstanding streams to terminate.|
347345
| __CONNECTION_CLOSE__ | 0x00000102 | The connection is being terminated. Stream ID MUST be 0. Sender or Receiver of this frame MUST wait for outstanding streams to terminate before closing the connection. New requests MAY not be accepted.|
348346
| __APPLICATION_ERROR__ | 0x00000201 | Application layer logic generating a Reactive Streams _onError_ event. Stream ID MUST be > 0. |
349-
| __REJECTED__ | 0x00000202 | Despite being a valid request, the Responder decided to reject it. The Responder guarantees that it didn't process the request. The reason for the rejection is explained in the metadata section. Stream ID MUST be > 0. |
347+
| __REJECTED__ | 0x00000202 | Despite being a valid request, the Responder decided to reject it. The Responder guarantees that it didn't process the request. The reason for the rejection is explained in the Error Data section. Stream ID MUST be > 0. |
350348
| __CANCELED__ | 0x00000203 | The responder canceled the request but potentially have started processing it (almost identical to REJECTED but doesn't garantee that no side-effect have been started). Stream ID MUST be > 0. |
351349
| __INVALID__ | 0x00000204 | The request is invalid. Stream ID MUST be > 0. |
352350
| __RESERVED__ | 0xFFFFFFFF | __Reserved for Extension Use__ |
@@ -576,14 +574,11 @@ Frame Contents
576574
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
577575
| Stream ID |
578576
+-----------+-+-+---------------+-------------------------------+
579-
|Frame Type |0|M| Flags |
577+
|Frame Type |0|0| Flags |
580578
+-------------------------------+-------------------------------+
581-
Metadata
582579
```
583580

584581
* __Frame Type__: (6 bits = max value 63) 0x09
585-
* __Flags__: (10 bits)
586-
* (__M__)etadata: Metadata present
587582

588583
<a name="frame-payload"></a>
589584
### PAYLOAD Frame (0x0A)

0 commit comments

Comments
 (0)