TElSimpleSFTPClient.OnBlockTransferPrepared event

TElSimpleSFTPClient.OnBlockTransferPrepared

This event is fired when a block of data has been prepared for transfer.

Declaration

[C#]
event TSBSftpBlockTransferPreparedEvent OnBlockTransferPrepared;
delegate void TSBSftpBlockTransferPreparedEvent(Object Sender, long Offset, long Size, TSBSftpTransferDirection Direction, bool TextMode, ref int BlockSize, ref int PipelineLength);

[VB.NET]
Event OnBlockTransferPrepared As TSBSftpBlockTransferPreparedEvent
Delegate Sub TSBSftpBlockTransferPreparedEvent(ByVal Sender As Object, ByVal Offset As Long, ByVal Size As Long, ByVal Direction As TSBSftpTransferDirection, ByVal TextMode As Boolean, ByRef BlockSize As Integer, ByRef PipelineLength As Integer)

[Pascal]
property OnBlockTransferPrepared : TSBSftpBlockTransferPreparedEvent;
TSBSftpBlockTransferPreparedEvent = procedure(Sender : TObject; Offset : Int64; Size : Int64; Direction : TSBSftpTransferDirection; TextMode : boolean; var BlockSize : integer; var PipelineLength : integer) of object;

[C++]
    void get_OnBlockTransferPrepared(TSBSftpBlockTransferPreparedEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnBlockTransferPrepared(TSBSftpBlockTransferPreparedEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBSftpBlockTransferPreparedEvent)(void * _ObjectData, TObjectHandle Sender, int64_t Offset, int64_t Size, TSBSftpTransferDirectionRaw Direction, int8_t TextMode, int32_t &BlockSize, int32_t &PipelineLength);

[PHP]
    TSBSftpBlockTransferPreparedEvent|callable|NULL get_OnBlockTransferPrepared()
    void set_OnBlockTransferPrepared(TSBSftpBlockTransferPreparedEvent|callable|NULL $Value)
    callable TSBSftpBlockTransferPreparedEvent(TObject $Sender, integer $Offset, integer $Size, integer $Direction, bool $TextMode, integer &$BlockSize, integer &$PipelineLength)

[Java]
    TSBSftpBlockTransferPreparedEvent getOnBlockTransferPrepared();
    void setOnBlockTransferPrepared(TSBSftpBlockTransferPreparedEvent Value);
    TSBSftpBlockTransferPreparedEvent.Callback OnBlockTransferPrepared = new TSBSftpBlockTransferPreparedEvent.Callback() {
        public void TSBSftpBlockTransferPreparedEventCallback(TObject Sender, long Offset, long Size, TSBSftpTransferDirection Direction, boolean TextMode, TSBInteger BlockSize, TSBInteger PipelineLength) {
            //...
        }
    }

Parameters

Offset - specifies data offset.
Size - specifies the size of the data.
Direction - data transfer direction (upload or download).
TextMode - specifies if the transfer will be in text mode.
BlockSize - this parameter specifies the data block size.
PipelineLength - this parameter specifies the number of upload or download requests sent before waiting for all requests to complete.

Direction values:

[.NET] [C++]	[Pascal]	Description
tdDownload = 0	tdDownload	Download direction
tdUpload = 1	tdUpload	Upload direction

Description

This event is fired by SFTP client right before each block of file is uploaded or downloaded. It allows the user to adjust the pipeline length and transfer block size (independently of whether AutoAdjustTransferBlock is set or not).

Discuss this help topic in SecureBlackbox Forum