reconnect2.0.2 • Public • Published
Reconnect a stream (tcp, ws, tls, http) when network goes down.
This module should now be considered legacy, it is recommend to use reconnect-core directly. This module is now only a bundle of wrappers around reconnect-core.
- shoe (websocket fallback - on the client-side)
- sockjs-stream (server side websockets)
Pass a function that will be called every time the stream connects. if the connection is broken, reconnect will make a new connection and call this function again.
var reconnect =
websockets can be used from both the client and the server, with the same code!
var reconnect =
a shoe server must be used.
reconnect (opts, onConnect)
opts is an object it will be passed to backoff
which handles throttling the reconnection attempts. it also accepts a
type parameter, which may
//example optsvar opts =randomisationFactor: 0initialDelay: 10maxDelay: 300
opts is optional. If
true then we will treat the
stream as if it does not emit a
"connect" event and fall back to listening
to the first piece of data. This is useful for non connection streams like
database cursors or tailing files.
onConnect to reconnect is short hand for
attempt to connect. the arguments will be passed onto the underlying stream type.
(either you are calling
these arguments will be used for every subsequent connection attempt.
emitted when a new connection is made (that includes after a disconnection!)
emitted when the stream has disconnected.
emit ('backoff', attempts, delay)
reemitted from backoff when reconnect is waiting for the next time to connect.
emit ('reconnect', attempts, delay)
emitted when attempting a new connection.
reconnect will not automatically reconnect.
starts out true.
Use reconnect-core instead.
The reconnect widget has been moved into a separate module reconnect-widget