Document maximum close reason length #5913
Merged
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
yschimke
approved these changes
Mar 29, 2020
yschimke
reviewed
Mar 29, 2020
| @@ -98,8 +98,8 @@ interface WebSocket { | |||
| * | |||
| * @param code Status code as defined by | |||
| * [Section 7.4 of RFC 6455](http://tools.ietf.org/html/rfc6455#section-7.4). | |||
| * @param reason Reason for shutting down or null. | |||
| * @throws IllegalArgumentException if code is invalid. | |||
| * @param reason Reason for shutting down, no longer than 123 bytes of UTF-8 encoded data (**not** characters) or null. | |||
There was a problem hiding this comment.
This is quite explicit, but given our draconian failures for a String API, probably warranted.
swankjesse
approved these changes
Mar 30, 2020
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.
This PR adds documentation to the exception which is thrown when the close reason is longer than 123 UTF-8 encoded bytes, addressing concerns from #5594. There are preexisting tests for this behavior yet it is currently undocumented.