sending a javascript object through websockets with faye

Question

Hi all I'm trying to send a javascript object through websockets:

the faye-websockets documentation says:

send(message) accepts either a String or a Buffer and sends a text or binary message over the connection to the other peer.

server side I'm using node and faye.

var WebSocket = require('faye-websocket');
var http = require('http');

var server = http.createServer();
server.addListener('upgrade', function(request, socket, head) {
    var ws = new WebSocket(request, socket, head);
    ws.send({topic:'handshake', data:'sdf487rgiuh7'});
});
server.listen(8000);

client side:

<script>
    var ws = new WebSocket('ws://localhost:8000');
    ws.onmessage = function(e) {
        console.log(e.data); //prints [Object object] string and not the object
    };
</script>

what is my error? Thanks

The -1 is likely due to the fact that the error message has already told you exactly what is wrong. — , May 18 '15 at 04:47

score 104 · Accepted Answer · answered Oct 23 '12 at 15:39

104

WebSockets support sending and receiving: strings, typed arrays (ArrayBuffer) and Blobs. Javascript objects must be serialized to one of the above types before sending.

To send an object as a string you can use the builtin JSON support:

ws.send(JSON.stringify(object));

To send an object as a typed array you can use a javascript BSON library such as this one:

ws.send(BSON.serialize(object));

When you receive a WebSocket message you will need to deserialize it.

To deserialize a JSON string from a WebSocket message:

ws.onmessage = function (e) {
    var object = JSON.parse(e.data);
    ...
};

If you are using binary messages over WebSocket, then first you should set the binaryType attribute in order to receive all binary messages as typed arrays:

ws.binaryType = "arraybuffer";

Then the deserialization will look like this:

ws.onmessage = function (e) {
    var object = BSON.deserialize(e.data);
    ...
};

Here is a blog post about using BSON in Javascript;

answered Oct 23 '12 at 15:39

kanaka

70,845
23
144
140

2

Your link is dead :/ And there aren't any readme.md on the git repo of js-bson. Gonna search some doc. – Vadorequest Nov 14 '14 at 13:18
1

Is it possible that the `onmessage` callback doesn't return the entire json string, and therefore `JSON.parse` throws a parsing error? – Martin Konecny Feb 17 '15 at 23:21
3

@MartinKonecny WebSockets is message based and messages are delivered in full (no partial messages). However, note that if you have something like websockify in the middle and you're actually talking to a regular TCP server on the other end, the message divisions are arbitrary (depend on TCP packet size, kernel window sizes, buffer sizes, etc). In that case you need to do some kind of re-assembly yourself. – kanaka Feb 18 '15 at 02:58
Thanks, I thought websockets were just plain sockets initiated via http. Good to know to is message based. – Martin Konecny Feb 18 '15 at 03:42

score 3 · Answer 2 · answered Jan 09 '18 at 12:29

3

Client:

const bson = new BSON();
ws.binaryType = 'arraybuffer';

ws.onmessage = function(event) {
  console.log(bson.deserialize(Buffer.from(event.data)));
}

Server:

 const data = bson.serialize({ ... });
 ws.send(data);

answered Jan 09 '18 at 12:29

Alex Ivasyuv

8,585
17
72
90

score 2 · Answer 3 · answered Oct 23 '12 at 11:00

2

I'm basically working with Socket.IO, but it looks like you need to stringify your data in the server and parse it in the client like so:

in the server:

ws.send(JSON.stringify({topic:'handshake', data:'sdf487rgiuh7'}));

in the client:

console.log(JSON.parse(e.data));

answered Oct 23 '12 at 11:00

udidu

8,269
6
48
68

in your case you are sending a string but since faye supports sending binary data I want to exploit this feature – frx08 Oct 23 '12 at 12:08
1

@frx08 An JS object is no binary data, an image would be. So udidus answer is correct. – dom Oct 23 '12 at 13:34
1

so the only method to serialize a js object is to stringify it? – frx08 Oct 23 '12 at 13:38
1

"Stringifying" an object is another way to say "serialize with JSON" – Michelle Tilley Oct 24 '12 at 01:07

Fabiel León · Answer 4 · 2023-01-12T23:37:59.083

2

add a function called json to the websocket object that transform in json and send the object passed by parameter

ws.json = (obj) => ws.send(JSON.stringify(obj));

ws.json({ message: "hello" });

edited Jan 12 '23 at 23:37

answered Oct 23 '22 at 22:54

Fabiel León

111
1
5

1

While this code may answer the question, providing additional context regarding how and/or why it solves the problem would improve the answer's long-term value. You can find more information on how to write good answers in the help center: https://stackoverflow.com/help/how-to-answer . Good luck – nima Oct 25 '22 at 08:48

score 0 · Answer 5 · answered Jun 12 '23 at 05:52

0

From the client side you can just send it via JSON.strigify and in the server side just do JSON.parse to get the data

answered Jun 12 '23 at 05:52

Jayesh Maheshwari

1
1

Your answer could be improved with additional supporting information. Please [edit] to add further details, such as citations or documentation, so that others can confirm that your answer is correct. You can find more information on how to write good answers [in the help center](/help/how-to-answer). – J4GD33P 51NGH Jun 12 '23 at 11:30

sending a javascript object through websockets with faye

5 Answers5

Linked