Discuss this help topic in SecureBlackbox Forum

TElSftpClient.MessageLoop

TElSftpClient     See also     


Filter: C#/Java  VB.NET  Pascal  C++  PHP  


This event is fired when Windows messages are to be handled.

Declaration

[C#/Java]
    event TSBSftpMessageLoopEvent MessageLoop;
    delegate void TSBSftpMessageLoopEvent();

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

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

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

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

Description

    This event is fired by TElSftpClient when the component is in synchronous mode and needs to process Windows messages. Depending on the architecture of your socket communication (synchronous or asynchronous) you can either process some messages from the message queue or just call Sleep(0) or do nothing. Return true if SFTP 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 TElSftpClient waits for synchronous server response. If this property is set to nil (null, Nothing), TElSftpClient uses its internal message loop to peek and dispatch messages.

     Note,  that this callback should be handled only if SynchronousMode property is set to true.

See also:     SynchronousMode    

Discuss this help topic in SecureBlackbox Forum