TElBaseSocketClient.OnReceive event

TElBaseSocketClient.OnReceive

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

Declaration

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

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

[Pascal]
property OnReceive : TSBReceiveEvent;
TSBReceiveEvent = procedure(Sender : TObject; Buffer : pointer; MaxSize : Int32; out Written : Int32) of object;

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

[Java]
    TSBReceiveEvent getOnReceive();
    void setOnReceive(TSBReceiveEvent Value);
    TSBReceiveEvent.Callback OnReceive = 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 the 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 were placed to the buffer.

Description

This event is fired by the TElBaseSocketClient when it needs to read some data from the socket. The application should fill Buffer with the amount of data no more than Length bytes and return the number of bytes written in Received parameter. The event is used only when the internal socket is used.