DataReceived Event

Reports receipt of another chunk of data from the server.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
virtual int FireDataReceived(SSHClientDataReceivedEventParams *e);

typedef struct {
  int Channel;
  int BytesReceived;
  int TotalBytesPending;
  int reserved;
} SSHClientDataReceivedEventParams;

Unicode (Windows)
virtual INT FireDataReceived(SSHClientDataReceivedEventParams *e);

typedef struct {
  INT Channel;
  INT BytesReceived;
  INT TotalBytesPending;
  INT reserved;
} SSHClientDataReceivedEventParams;

- (void)onDataReceived:(int)channel :(int)bytesReceived :(int)totalBytesPending;

#define EID_SSHCLIENT_DATARECEIVED 8

virtual INT SECUREBLACKBOXLITE_CALL FireDataReceived(INT &iChannel, INT &iBytesReceived, INT &iTotalBytesPending);

Remarks

This event fires in asynchronous mode to report the receipt of another chunk of data from the server. Use Receive or ReceiveBytes methodsto read out the received data.

The Channel parameter indicates the channel on which the data was received: stdout (0) or stderr (1). BytesReceived specify the size of the newly received chunk, and TotalBytesPending contain the total number of bytes available for reading.

Please note that just like other asynchronous mode events this event may fire from a secondary thread. Please make sure your code is prepared for that by using appropriate synchronization facilities.

This event does not fire in synchronous mode.