Skip to content

Commit

Permalink
Adding reference for socket.io warning
Browse files Browse the repository at this point in the history
Linking issue josephg#375 from README for users interested in Socket.IO.
  • Loading branch information
vote539 committed May 20, 2015
1 parent c53a3b0 commit 7af415d
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,14 @@ server. As such, its transport agnostic. You can use
[websockets](https://github.com/einaros/ws), or whatever you like. ShareJS
requires the transport to:

- Guarantee in-order message delivery. (**Danger danger socket.io does not guarantee this**)
- Provide a websocket-like API on the client
- Guarantee in-order message delivery.
- Provide a websocket-like API on the client.
- Provide a node object stream to the server to talk to a client.

**Caution:** If using [socket.io](http://socket.io/), you need to manually implement an
in-order message delivery mechanism. See
[issue #375](https://github.com/share/ShareJS/issues/375) for details.

When a client times out, the server will throw away all information
related to that client. When the client client reconnects, it will reestablish
all its state on the server again.
Expand Down

0 comments on commit 7af415d

Please sign in to comment.