Skip to content

Commit 4d6e706

Browse files
committed
update README
1 parent ed1303e commit 4d6e706

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,25 @@ An elegant socket.io client for .NET, Supports `.NET Standard 2.0`, support sock
99

1010
[Wiki](https://github.com/doghappy/socket.io-client-csharp/wiki)
1111

12+
# Breaking changes in 3.x (Not yet released)
13+
14+
> While WebSocket is clearly the best way to establish a bidirectional communication, experience has shown that it is not always possible to establish a WebSocket connection, due to corporate proxies, personal firewall, antivirus software…
15+
16+
https://socket.io/docs/v4/how-it-works/#Transports
17+
18+
- SocketIOClient v3.x supports http polling, but if websocket is available, the library will choose to use websocket. If you want to use http polling and do not want the library to upgrade the transport, please set `Options.AutoUpgrade = false`.
19+
- Socket.io server v2.x is no longer supported. If a large number of users use this version, please feedback.
20+
21+
### Specific break changes
22+
23+
#### 1. EIO option removed
24+
25+
Since socket.io server v2 is not supported, the EIO option is not required.
26+
27+
#### 2. Removed the 'Socket' object
28+
29+
Use ClientWebSocketProvider instead of Socket object.
30+
1231
# Breaking changes in 2.2.4
1332

1433
Before SocketIOClient v2.2.4, the default EIO is 3, which works with socket.io v2.x, in SocketIOClient v2.2.4, the default EIO is 4, which works with socket.io v3.x and v4.x

0 commit comments

Comments
 (0)