diff --git a/README.md b/README.md index 14b8216..ad6dd69 100644 --- 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 index a3bfd3c..47badeb 160000 --- a/node_modules/nodeBase +++ b/node_modules/nodeBase @@ -1 +1 @@ -Subproject commit a3bfd3c944fa69361d3d1b237c7173dc2994ef9a +Subproject commit 47badeb8d5bbdc4147076b9b8c3d97da8402c210