added documentation, updated Readme

dotmaster · Mar 21, 2011 · 13247f8 · 13247f8
1 parent 5d65add
commit 13247f8
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -59,6 +59,39 @@ Logging can be turned on/off in nodeClient by passing an option to the nodeClien
 
 NEW from 0.0.2! Now uses nodeBase to do coherent logging.
 
+## Events
+
+- reconnect-failed //emitted after all reconnection attempts failed and we are not trying to connect anymore, until manualConnect() is called
+- reconnecting
+- disconnect
+- connect
+
+## Methods
+
+- connect()
+- disconnect()
+- manualConnect() ... like connect, but resets the retry timeout and status variable first
+
+## Status variables
+
+- connected
+- connecting
+- reconnecting
+
+#options
+
+- logging: true,
+- logLevel: 'ALL'
+
+socket.io specific options
+
+- reconnect: true,
+- secure: false,
+- timeout: 25000,// if no heartbeat message is received in this time frame, we consider the client disconnected
+- resource: 'socket.io'
+- maxReconnectionAttempts: 10,
+- reconnectionDelay: 500
+
 ## Modifications to Socket.io
 
 - a static function called addTransport is exposed to the outside world to add new transports to socket.io

diff --git a/node_modules/nodeBase b/node_modules/nodeBase