Binary support #244
Merged
Binary support #244
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
| @@ -131,6 +131,7 @@ function Socket(uri, opts){ | |||
| this.upgrade = false !== opts.upgrade; | |||
| this.path = (opts.path || '/engine.io').replace(/\/$/, '') + '/'; | |||
| this.forceJSONP = !!opts.forceJSONP; | |||
| this.forceBase64 = !!opts.forceBase64; | |||
|
Thanks for the comments. I'll make the style changes. I totally agree about the test. I'll look into the feature detecting binary support for WebSockets. When it comes to base64 encoding, it is actually currently automatically decoded and handed in as binary if binary types are supported. Maybe this didn't come across that well from my documentation. I'll make that better. |
added 19 commits
February 1, 2014 19:01
…n there is no binaryType. If WebSocket doesn't support binary, this is communicated to the server through the upgrade packet.
…upgrade packet for WebSocket
added 19 commits
February 9, 2014 19:54
… support binary types
…g to a transport that doesn't support binary from one that does to avoid the overhead of base64 encoding
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 pull request answers to the issue of sending binary data over engine.io. Please take a look at the engine.io pull request for more details about binary on different transport methods.
With these changes binary data can be sent from the server to the client, and the other way around. The API for sending binary data is the same as for sending utf-8 strings, but binary types are detected. When a client on a browser calls
socket.sendfor anArrayBuffer, or anArrayBufferViewthe data is sent as binary. For a node server the possibilities are the aforementioned, and alsoBuffer. The data is then received as binary on the other end.On a browser client, the data is by default received as an
ArrayBuffer, but can be changed toBlobvia settingsocket.binaryType = 'blob'. If Blob is not supported, the default type is used. On a Node client the default type isBuffer, but can be set toArrayBufferwithsocket.binaryType = 'arraybuffer'. IfArrayBufferis not supported on browsers, then an object like this is returned:{ base64: true, data: data }, where data contains the binary data as a base64 string.The server needs to know when a client doesn't support XHR2 for binary data, so the client notifies the server of this by adding a b64 query parameter to the handshaking request. This will lead to binary messages travelling base64 encoded, even when using XHR polling.