DataIn Event

Fired when data comes in.

Syntax

ANSI (Cross Platform)
virtual int FireDataIn(SSHTunnelDataInEventParams *e);
typedef struct {
int ConnectionId;
const char *Text; int lenText;
int EOL; int reserved; } SSHTunnelDataInEventParams; Unicode (Windows) virtual INT FireDataIn(SSHTunnelDataInEventParams *e);
typedef struct {
INT ConnectionId;
LPCSTR Text; INT lenText;
BOOL EOL; INT reserved; } SSHTunnelDataInEventParams;
- (void)onDataIn:(int)connectionId :(NSData*)text :(BOOL)EOL;
#define EID_SSHTUNNEL_DATAIN 3

virtual INT IPWORKSSSH_CALL FireDataIn(INT &iConnectionId, LPSTR &lpText, INT &lenText, BOOL &bEOL);

Remarks

Trapping the DataIn event is your only chance to get the data coming from the other end of the connection specified by ConnectionId. The incoming data is provided through the Text parameter.

EOL indicates whether the EOL string was found at the end of Text or not. If the EOL string was found, then EOL is True.

If Text is part of data portion of length larger than either DefaultMaxLineLength or with no EOL strings in it, then EOL is False. Please note that this means that one or more DataIn events with EOL set to False can be received during a connection.

If the EOL property is "" (empty string), then EOL can be disregarded (it is always True).

Note that events are not re-entrant. Performing time consuming operations within this event will prevent it from firing again in a timely manner and may impact overall performance.

Copyright (c) 2023 /n software inc. - All rights reserved.
IPWorks SSH 2020 C++ Edition - Version 20.0 [Build 8501]