Skip to content

Commit 7b33e0a

Browse files
CANCELED Error Code (rsocket#219)
Include CANCELED in details throughout doc. Clarify wording on error description.
1 parent aff1845 commit 7b33e0a

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

Protocol.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,7 @@ The Error Data is typically an Exception message, but could include stringified
349349
| __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.|
350350
| __APPLICATION_ERROR__ | 0x00000201 | Application layer logic generating a Reactive Streams _onError_ event. Stream ID MUST be > 0. |
351351
| __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. |
352-
| __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. |
352+
| __CANCELED__ | 0x00000203 | The Responder canceled the request but may have started processing it (similar to REJECTED but doesn't guarantee lack of side-effects). Stream ID MUST be > 0. |
353353
| __INVALID__ | 0x00000204 | The request is invalid. Stream ID MUST be > 0. |
354354
| __RESERVED__ | 0xFFFFFFFF | __Reserved for Extension Use__ |
355355

@@ -990,7 +990,7 @@ Once a stream has "terminated", the Stream ID can be "forgotten" by the Requeste
990990
or
991991

992992
1. RQ -> RS: REQUEST_RESPONSE
993-
1. RS -> RQ: ERROR[APPLICATION_ERROR|REJECTED|INVALID]
993+
1. RS -> RQ: ERROR[APPLICATION_ERROR|REJECTED|CANCELED|INVALID]
994994

995995
or
996996

@@ -1003,7 +1003,7 @@ Upon receiving a CANCEL, the stream is terminated on the Responder and the respo
10031003

10041004
Upon sending a CANCEL, the stream is terminated on the Requester.
10051005

1006-
Upon receiving a COMPLETE or ERROR[APPLICATION_ERROR|REJECTED|INVALID], the stream is terminated on the Requester.
1006+
Upon receiving a COMPLETE or ERROR[APPLICATION_ERROR|REJECTED|CANCELED|INVALID], the stream is terminated on the Requester.
10071007

10081008
<a name="stream-sequences-fire-and-forget"></a>
10091009
### Request Fire-n-Forget
@@ -1021,7 +1021,7 @@ REQUEST_FNF are assumed to be best effort and MAY not be processed due to: (1) S
10211021

10221022
1. RQ -> RS: REQUEST_STREAM
10231023
1. RS -> RQ: PAYLOAD*
1024-
1. RS -> RQ: ERROR[APPLICATION_ERROR|REJECTED|INVALID]
1024+
1. RS -> RQ: ERROR[APPLICATION_ERROR|REJECTED|CANCELED|INVALID]
10251025

10261026
or
10271027

@@ -1041,9 +1041,9 @@ Upon receiving a CANCEL, the stream is terminated on the Responder.
10411041

10421042
Upon sending a CANCEL, the stream is terminated on the Requester.
10431043

1044-
Upon receiving a COMPLETE or ERROR[APPLICATION_ERROR|REJECTED|INVALID], the stream is terminated on the Requester.
1044+
Upon receiving a COMPLETE or ERROR[APPLICATION_ERROR|REJECTED|CANCELED|INVALID], the stream is terminated on the Requester.
10451045

1046-
Upon sending a COMPLETE or ERROR[APPLICATION_ERROR|REJECTED|INVALID], the stream is terminated on the Responder.
1046+
Upon sending a COMPLETE or ERROR[APPLICATION_ERROR|REJECTED|CANCELED|INVALID], the stream is terminated on the Responder.
10471047

10481048
<a name="stream-sequences-channel"></a>
10491049
### Request Channel
@@ -1088,7 +1088,7 @@ Upon sending a COMPLETE or ERROR[APPLICATION_ERROR|REJECTED|INVALID], the stream
10881088
intermixed with
10891089

10901090
1. RS -> RQ: PAYLOAD*
1091-
1. RS -> RQ: ERROR[APPLICATION_ERROR|REJECTED|INVALID]
1091+
1. RS -> RQ: ERROR[APPLICATION_ERROR|REJECTED|CANCELED|INVALID]
10921092

10931093
#### Error from Responder, Requester already Completed
10941094

@@ -1099,7 +1099,7 @@ Upon sending a COMPLETE or ERROR[APPLICATION_ERROR|REJECTED|INVALID], the stream
10991099
intermixed with
11001100

11011101
1. RS -> RQ: PAYLOAD*
1102-
1. RS -> RQ: ERROR[APPLICATION_ERROR|REJECTED|INVALID]
1102+
1. RS -> RQ: ERROR[APPLICATION_ERROR|REJECTED|CANCELED|INVALID]
11031103

11041104
#### Cancel from Requester, Responder terminates
11051105

@@ -1124,9 +1124,9 @@ Upon receiving a CANCEL, the stream is terminated on the Responder.
11241124

11251125
Upon sending a CANCEL, the stream is terminated on the Requester.
11261126

1127-
Upon receiving an ERROR[APPLICATION_ERROR|REJECTED|INVALID], the stream is terminated on both Requester and Responder.
1127+
Upon receiving an ERROR[APPLICATION_ERROR|REJECTED|CANCELED|INVALID], the stream is terminated on both Requester and Responder.
11281128

1129-
Upon sending an ERROR[APPLICATION_ERROR|REJECTED|INVALID], the stream is terminated on both the Requester and Responder.
1129+
Upon sending an ERROR[APPLICATION_ERROR|REJECTED|CANCELED|INVALID], the stream is terminated on both the Requester and Responder.
11301130

11311131
In absence of ERROR or CANCEL, the stream is terminated after both Requester and Responder have sent and received COMPLETE.
11321132

0 commit comments

Comments
 (0)