TElFTPSServer.OnDataReceive event

TElFTPSServer.OnDataReceive

This event is used to read data from the data channel.

Declaration

[C#]
event TSBReceiveEvent OnDataReceive;
delegate void TSBReceiveEvent(Object Sender, ref byte[] Buffer, int MaxSize, out int Written);

[VB.NET]
Event OnDataReceive As TSBReceiveEvent
Delegate Sub TSBReceiveEvent(ByVal Sender As Object, ByRef Buffer As Byte(), ByVal MaxSize As Integer, Out Written As Integer)

[Pascal]
property OnDataReceive : TSBReceiveEvent;
TSBReceiveEvent = procedure (Sender: TObject; Buffer : Pointer; MaxSize : LongInt; out Written : LongInt) of object;

[C++]
    void get_OnDataReceive(TSBReceiveEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnDataReceive(TSBReceiveEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBReceiveEvent)(void * _ObjectData, TObjectHandle Sender, void * Buffer, int32_t MaxSize, int32_t &Written);

[Java]
    TSBReceiveEvent getOnDataReceive();
    void setOnDataReceive(TSBReceiveEvent Value);
    TSBReceiveEvent.Callback OnDataReceive = new TSBReceiveEvent.Callback() {
        public void TSBReceiveEventCallback(TObject Sender, byte[] Buffer, int MaxSize, TSBInteger Written) {
            //...
        }
    }

Parameters

Buffer - the buffer that should be filled with data which were read from the socket by application.
MaxSize - the length of the buffer. Specifies the maximum number of bytes that can be written to the buffer.
Written - the amount of data that was placed to the buffer.

Description

This event is fired by TElFTPSServer when it needs to read some data from the socket. Usually this is caused by the call to DataAvailable. The application should fill the Buffer with the amount of data not more than MaxSize bytes and return the number of bytes written in Written parameter.