This repository has been archived by the owner on Sep 6, 2021. It is now read-only.
Receive binary Brackets-Node command responses #6339
Merged
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 pull request updates
NodeConnection
so that it can receive binary responses to commands in Node domains. When a binary message --- i.e., anArrayBuffer
instance; i.e., an array of bytes; i.e., not a string to be interpreted as JSON --- is received via the WebSocket, the first four bytes are assumed to be a header and are interpreted as a (32-bit unsigned integer) command ID. The header is then stripped off and the pending deferred of the corresponding command is resolved with the remaining bytes. Clients can then interpret or process the bytes arbitrarily.To ensure that the command ID can always be encoded as a 32-bit unsigned integer, IDs are now restricted to the range
0 <= id < 2^32
. When the maximum value is eclipsed, the counter just rolls back to 0. (This could be improved, but the bugs in this PR already exist in the current implementation, so I'm not too worried about it.)This should be reviewed in tandem with a companion brackets-shell pull request, adobe/brackets-shell#406, which allows domain commands to return binary responses.