Socket.io-client: Document 'ping' and 'pong' events in http://socket.io/docs

Created on 13 Nov 2016 · 10Comments · Source: socketio/socket.io-client

ping and pong events are undocumented in the website (socket.io/docs), potentially causing confusion when somebody tries to implement their own ping-pong system. socket.emit('pong') on the browser does not cause anything to be sent over the socket (verified with localStorage.debug = '*';), maybe socket.emit('ping') should also report an error letting the developer know it's a reserved keyword.

From README.md:

- `ping`. Fired when a ping packet is written out to the server.
- `pong`. Fired when a pong is received from the server.
    Parameters:
    - `Number` number of ms elapsed since `ping` packet (i.e.: latency)."

Source

joonas-lahtinen

👍6

Most helpful comment

Is ping/pong not some real basic shit in networking? why the hell would they not be documented? There are ping and pong events sent back and fourth between the server and client automatically (upon socket connection)? If so, how do i look at these events and their timestamps to measure latency?

ForgeableSum on 9 Jun 2017

👍6

All 10 comments

Agreed!
I know one must read the fabulous manual, but I still managed to lost a couple of hours (and hair) figuring out why the hell my code wasn't working.
Totally my fault, but I would have liked it a lot if I was thrown some warning saying "Those events are reserved, try something else".

hugohil on 24 Nov 2016

PR is welcome, as usual!

darrachequesne on 24 Nov 2016

I already considered that, but I failed to find a repository that contains the website source. Maybe I'm just incompetent or was too tired, can you point me to it?

joonas-lahtinen on 24 Nov 2016

I just started looking at this (see here) but this comes with a need of something like a verbose parameter. Plus I'm pretty sure this is also triggered by those "internal" events. And finally console.warn.calledWith() does not exist in expect.
Still need some work ...

hugohil on 24 Nov 2016

Closing due to inactivity, please reopen if needed.

darrachequesne on 10 Jan 2017

It's hard to know if the issue was fixed or not, due to #1054 (the page renders nothing currently).

joonas-lahtinen on 10 Jan 2017

ForgeableSum on 9 Jun 2017

👍6

Can we reopen this, I agree with ForgeableSum. We should have more documentation.

tcaer on 20 Jun 2017

👍3

Well it's already documented https://github.com/socketio/socket.io-client/blob/master/docs/API.md#event-ping-1 , I was struggling for hours trying to receive data from a custom ping event sent by my client, it seems that you can't override this event. 😅