on_data_in Event

Fired when data comes in.

Syntax

class SSHTunnelDataInEventParams(object):
  @property
  def connection_id() -> int: ...
  @property
  def text() -> bytes: ...
  @property
  def eol() -> bool: ...

# In class SSHTunnel:
@property
def on_data_in() -> Callable[[SSHTunnelDataInEventParams], None]: ...
@on_data_in.setter
def on_data_in(event_hook: Callable[[SSHTunnelDataInEventParams], None]) -> None: ...

Remarks

Trapping the on_data_in 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 default_max_line_length or with no eol strings in it, then EOL is False. Please note that this means that one or more on_data_in 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.