TElSimpleSSHClient.MessageLoop event

TElSimpleSSHClient.MessageLoop

This event is fired when the component yields execution to the application.

Declaration

[C#]
event TSSHMessageLoopEvent MessageLoop;
delegate void TSSHMessageLoopEvent();

[VB.NET]
Event MessageLoop As TSSHMessageLoopEvent
Delegate Sub TSSHMessageLoopEvent()

[Pascal]
property MessageLoop : TSBSftpMessageLoopEvent;
TSBSftpMessageLoopEvent = function : boolean of object;

[C++]
    void get_MessageLoop(TSSHMessageLoopEvent &pMethodOutResult, void * &pDataOutResult);
    void set_MessageLoop(TSSHMessageLoopEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSSHMessageLoopEvent)(void * _ObjectData);

[PHP]
    TSSHMessageLoopEvent|callable|NULL get_MessageLoop()
    void set_MessageLoop(TSSHMessageLoopEvent|callable|NULL $Value)
    callable TSSHMessageLoopEvent()

[Java]
    TSSHMessageLoopEvent getMessageLoop();
    void setMessageLoop(TSSHMessageLoopEvent Value);
    TSSHMessageLoopEvent.Callback MessageLoop = new TSSHMessageLoopEvent.Callback() {
        public boolean TSSHMessageLoopEventCallback() {
            //...
        }
    }

Description

This event is fired by TElSimpleSSHClient when the component needs to process Windows messages or give away the time slice to application. Return true if SSH client can continue or false if blocking operation must be stopped.
Use this callback function if you wish to process all incoming messages yourself while TElSimpleSSHClient waits for synchronous server response. If this property is set to nil (null, Nothing), TElSimpleSSHClient uses its internal message loop to peek and dispatch messages.

Discuss this help topic in SecureBlackbox Forum