Skip to content

Commit 04a2bbe

Browse files
docs: add note about the CSR feature
Related: socketio/socket.io#4733
1 parent 8981be0 commit 04a2bbe

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

docs/categories/01-Documentation/connection-state-recovery.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,15 @@ sidebar_position: 4
44
slug: /connection-state-recovery
55
---
66

7-
Connection state recovery is a feature which allows restoring a client's state after a temporary disconnection (including any missed packets).
7+
Connection state recovery is a feature which allows restoring a client's state after a temporary disconnection, including any missed packets.
8+
9+
:::info
10+
11+
This feature was added in version `4.6.0`, released in February 2023.
12+
13+
The release notes can be found [here](../../changelog/4.6.0.md).
14+
15+
:::
816

917
## Disclaimer
1018

@@ -111,6 +119,12 @@ foo => the event name (socket.emit("foo"))
111119
MzUPkW0 => the offset
112120
```
113121

122+
:::note
123+
124+
For the recovery to succeed, the server must send at least one event, in order to initialize the offset on the client side.
125+
126+
:::
127+
114128
- upon temporary disconnection, the server stores the client state for a given delay (implemented at the adapter level)
115129

116130
- upon reconnection, the client sends both the session ID and the last offset it has processed, and the server tries to restore the state

0 commit comments

Comments
 (0)