Option to change how websocket data frames are returned to the client #39
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
The websocket specification defines 2 ways how application-layer data transmitted over the socket can be represented: `Text` or `Binary`. Currently the default data frame representation returned by the RPC server is `Binary` but this is counterintuitive since JSONRPC already is in a text representation. This PR let the client, per connection, decide in which representation data should be returned by the server. This is achived by adding support for a `frame` query parameter on the `/ws` endpoint. Examples: - ws://127.0.0.1:8000/ws --> data frames are returned as `Binary` (default) - ws://127.0.0.1:8000/ws?frame=text --> data frames are returned as `Text` - ws://127.0.0.1:8000/ws?frame=binary --> data frames are returned as `Binary` - ws://127.0.0.1:8000/ws?frame=foo --> data frames are returned as `Binary` (Fallback for unsupported values) To accomplish backwards compatibility `Binary` is still the default returned representation but in a major release this should be changed to `Text`
Eligioo
force-pushed
the
stefan/websocket-text-frames
branch
from
9ae342d to
e5c81ae
Compare
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.
The websocket specification defines 2 ways how application-layer data transmitted over the socket can be represented:
TextorBinary. Currently the default data frame representation returned by the RPC server isBinarybut this is counterintuitive since JSONRPC already is in a text representation.This PR let the client, per connection, decide in which representation data should be returned by the server. This is achived by adding support for a
framequery parameter on the/wsendpoint. Examples:Binary(default)TextBinaryBinary(Fallback for unsupported values)To accomplish backwards compatibility
Binaryis still the default returned representation but in a major release this should be changed toText