Disconnected Event

Fired when a connection is closed.

Syntax

sshtunnel.on('Disconnected', [callback])

Callback

The 'callback' is called when the 'Disconnected' event is emited.

function(e){ }

The argument 'e' has the following properties:

e.connectionId
e.statusCode
e.description

Remarks

If the connection is broken normally, StatusCode is 0, and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Messages section for more information.