[docs] Added Rejection Reasons document #2762
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
maxsharabayko
added
Type: Enhancement
|
|
||
| ## Summary of Rejection Codes | ||
|
|
||
| Rejection codes are used in the SRT API, and are transferred on the wire as a part of a Handshake packet (refer to the `Handshake Type` field of the Handshake packet). |
There was a problem hiding this comment.
Suggested change
| Rejection codes are used in the SRT API, and are transferred on the wire as a part of a Handshake packet (refer to the `Handshake Type` field of the Handshake packet). | |
| Rejection codes are used in the SRT API, and are transferred on the wire as a part of a Handshake packet (refer to the `Handshake Type` field of the [Handshake](./docs/features/handshake.md) packet). |
|
|
||
| - `SRT_REJ`: standard rejection codes from SRT API functions (0 - 99) | ||
| - `SRT_REJC`: mark the border values between ranges. | ||
| - `SRT_REJX`: extended rejection codes (400 – 599) :warning: *@max is this the correct range (see comments above)?* |
There was a problem hiding this comment.
See inline comment.
There was a problem hiding this comment.
Should be simply "code values above 1000", if you speak about the SRT_REJX prefix.
| making sure that the applications at either end of a connection understand them. | ||
|
|
||
| The intention here is for the predefined codes to be consistent with the HTTP | ||
| standard codes. Such code can be set by using the `srt_setrejectreason` function. |
There was a problem hiding this comment.
Suggested change
| standard codes. Such code can be set by using the `srt_setrejectreason` function. | |
| standard codes. Such code can be set by using the [`srt_setrejectreason`](docs/api/api-functions.md#srt-setrejectreason) function. |
| @@ -0,0 +1,470 @@ | |||
| # SRT Rejection Codes | |||
|
|
|||
| This document provides an overview of the rejection (error) codes used by and supported within SRT and SRT-based applications. | |||
There was a problem hiding this comment.
Suggested change
| This document provides an overview of the rejection (error) codes used by and supported within SRT and SRT-based applications. | |
| This document provides an overview of the rejection (error) codes used by and supported within SRT and SRT-based applications. For information on other types of error codes refer to the [API Socket Options](./docs/API/API-socket-options.md) document. |
ethouris
reviewed
Oct 6, 2023
|
|
||
| ### SRT Internal Rejection Codes | ||
|
|
||
| Defined in [**srt.h**](srtcore/srt.h), these codes provide the reason why a connection is rejected by SRT. They cover the reserved range 0 - 999 (below `SRT_REJC_PREDEFINED`). |
There was a problem hiding this comment.
Suggested change
| Defined in [**srt.h**](srtcore/srt.h), these codes provide the reason why a connection is rejected by SRT. They cover the reserved range 0 - 999 (below `SRT_REJC_PREDEFINED`). | |
| Defined in [**srt.h**](srtcore/srt.h), these codes provide the reason why a connection is rejected by SRT. They cover the reserved range 0 - 999 (below `SRT_REJC_PREDEFINED`). These codes cannot be used by applications to report a rejection reason. |
ethouris
reviewed
Oct 6, 2023
| - `SRT_REJ_SYSTEM` = 1 | ||
| - ... | ||
| - `SRT_REJ_CRYPTO` = 17 | ||
|
|
There was a problem hiding this comment.
Suggested change
| See [the list below](#api-function-rejection-codes) for details. |
ethouris
reviewed
Oct 6, 2023
| - `SRT_REJX`: extended rejection codes (400 – 599) :warning: *@max is this the correct range (see comments above)?* | ||
|
|
||
|
|
||
| ## API Function Rejection Reasons |
There was a problem hiding this comment.
Wasn't exactly the same already collected in a table above?
ethouris
reviewed
Oct 6, 2023
| #### SRT_REJ_CLOSE | ||
|
|
||
| The listener socket was able to receive the request, but is currently | ||
| being closed. It's likely that the next request will result in a timeout. |
maxsharabayko
commented
Jan 9, 2024
| | 1403 | [SRT_REJX_FORBIDDEN](#SRT_REJX_FORBIDDEN) | 1.4.2 | Access denied to the resource for any reason. | | ||
| | 1404 | [SRT_REJX_NOTFOUND](#SRT_REJX_NOTFOUND) | 1.4.2 | Resource specified by `r` and `h` keys cannot be found. | | ||
| | 1405 | [SRT_REJX_BAD_MODE](#SRT_REJX_BAD_MODE) | 1.4.2 | Mode specified in the `m` key in StreamID is not supported for this request. | | ||
| | 1406 | [SRT_REJX_UNACCEPTABLE](#SRT_REJX_UNACCEPTABLE) | 1.4.2 | Unavailable parameters in `SocketID`, or `m=publish` data format not supported. | |
There was a problem hiding this comment.
Suggested change
| | 1406 | [SRT_REJX_UNACCEPTABLE](#SRT_REJX_UNACCEPTABLE) | 1.4.2 | Unavailable parameters in `SocketID`, or `m=publish` data format not supported. | | |
| | 1406 | [SRT_REJX_UNACCEPTABLE](#SRT_REJX_UNACCEPTABLE) | 1.4.2 | Unavailable parameters in `StreamID`, or `m=publish` data format not supported. | |
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.
Fixes #2742.