TElSSHTunnelConnection.OnClose event

Navigation

TElSSHTunnelConnection.OnClose

This event is fired when the logical connection is closed

Declaration

[C#]
    event TSSHChannelCloseEvent OnClose;
    delegate void TSSHChannelCloseEvent(object Sender, TSSHCloseType CloseType);

    enum TSSHCloseType {ctReturn = 0, ctSignal = 1, ctError = 2};

[VB.NET]
    Event OnClose As TSSHChannelCloseEvent
    Delegate Sub TSSHChannelCloseEvent(ByVal Sender As Object, ByVal CloseType As TSSHCloseType)

    Enum TSSHCloseType
      ctReturn = 0
      ctSignal = 1
      ctError = 2
    End Enum

[Pascal]
    property OnClose : TSSHChannelCloseEvent;
    TSSHChannelCloseEvent = procedure (Sender: TObject; CloseType : TSSHCloseType) of object;

    TSSHCloseType = (ctReturn, ctSignal, ctError);

[VB6]
    Event OnClose(eCloseType As tagTxSSHCloseType)

    Enum tagTxSSHCloseType
      Const TxctReturn = 0
      Const TxctSignal = 1
      Const TxctError = 2
    End Enum

[ActiveX]
    void _stdcall OnClose([in] TxSSHCloseType eCloseType);

    typedef enum tagTxSSHCloseType{
      TxctReturn=0,
      TxctSignal=1,
      TxctError=2
    } TxSSHCloseType;

[DLL]
not implemented;

Parameters

CloseType (eCloseType) - specifies reason of connection closing

Values

[.NET] [Pascal] [ActiveX] Description

ctReturn = 0 ctReturn TxctReturn=0 connection was closed normally (EOF mark was received)

ctSignal = 1 ctSignal TxctSignal=1 remote application closed the connection

ctError = 2 ctError TxctError=2 error closing

Declared in

[.NET] [Pascal]

Namespace: SBSSHCommon
Assembly: SecureBlackbox.SSHCommon Unit: SBSSHCommon

Description

    This event is fired when the logical connection is closed. No more data should be sent to this connection after receiving this event.

    Note that you don't need to destroy the instance of this class. It is destroyed automatically by the tunnel class to which this connection belongs.

    [ActiveX] Note you can not use this event directly. Use TElSSHTunnelConnectionList.OnClose event instead.