on_disconnected Event

Fired when a connection is closed.

Syntax

class SSHTunnelDisconnectedEventParams(object):
  @property
  def connection_id() -> int: ...
  @property
  def status_code() -> int: ...
  @property
  def description() -> str: ...

# In class SSHTunnel:
@property
def on_disconnected() -> Callable[[SSHTunnelDisconnectedEventParams], None]: ...
@on_disconnected.setter
def on_disconnected(event_hook: Callable[[SSHTunnelDisconnectedEventParams], None]) -> None: ...

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 Codes section for more information.

Note: When the class is disconnected from the SSH server for any reason the ConnectionId parameter will be -1.