TElSSHTunnelConnection.OnClose event

TElSSHTunnelConnection.OnClose

This event is fired when the logical connection is closed

Declaration

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

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

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

    TSSHCloseType = (ctReturn, ctSignal, ctError);

[C++]
    void get_OnClose(TSSHChannelCloseEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnClose(TSSHChannelCloseEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSSHChannelCloseEvent)(void * _ObjectData, TObjectHandle Sender, TSSHCloseTypeRaw CloseType);

[PHP]
    TSSHChannelCloseEvent|callable|NULL get_OnClose()
    void set_OnClose(TSSHChannelCloseEvent|callable|NULL $Value)
    callable TSSHChannelCloseEvent(TObject $Sender, integer $CloseType)

[Java]
    TSSHChannelCloseEvent getOnClose();
    void setOnClose(TSSHChannelCloseEvent Value);
    TSSHChannelCloseEvent.Callback OnClose = new TSSHChannelCloseEvent.Callback() {
        public void TSSHChannelCloseEventCallback(TObject Sender, TSSHCloseType CloseType) {
            //...
        }
    }

Parameters

CloseType (eCloseType) - specifies reason of connection closing

Values

[.NET] [C++]	[Pascal]	Description
ctReturn = 0	ctReturn	connection was closed normally (EOF mark was received)
ctSignal = 1	ctSignal	remote application closed the connection
ctError = 2	ctError	error closing

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.