Skip to content

refactor(docs): improve engineio heartbeat mechanism docs #515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Levi0804 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

refactor(docs): improve engineio heartbeat mechanism docs #515

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/categories/08-Miscellaneous/eio-protocol.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,12 +234,16 @@ CLIENT SERVER

│ *** Handshake *** │
│ │
│ ◄───────────────────────────────────────────────── │
│ GET /engine.io/?EIO=4&transport=polling&sid=... │
│ ─────────────────────────────────────────────────► │
│ ◄────────────────────────────────────────────────┘ │
│ 2 │ (ping packet)
│ ─────────────────────────────────────────────────► │
│ 3 │ (pong packet)
```

The client now starts polling the server again (to start receiving the `ping` packet), and includes the `sid` (sent in the handshake process) query parameter in all subsequent requests.

At a given interval (the `pingInterval` value sent in the handshake) the server sends a `ping` packet and the client has a few seconds (the `pingTimeout` value) to send a `pong` packet back.

If the server does not receive a `pong` packet back, then it SHOULD consider that the connection is closed.
Expand Down