From 7af415d9bc01172c3b6ce1ae14526b08b6de489b Mon Sep 17 00:00:00 2001 From: vote539 Date: Wed, 20 May 2015 10:31:44 -0500 Subject: [PATCH] Adding reference for socket.io warning Linking issue #375 from README for users interested in Socket.IO. --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 12b7632d..6f029c37 100644 --- a/README.md +++ b/README.md @@ -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.