IPWorks WebSockets 2020 Python Edition

Questions / Feedback?

on_data_in Event

Fired when data is received.

Syntax

class WebSocketClientDataInEventParams(object):
  @property
  def data_format() -> int: ...
  @property
  def text() -> bytes: ...
  @property
  def eom() -> bool: ...

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

Remarks

The on_data_in event provides the data received from the remote host.

The incoming data is provided through the Text parameter.

The DataFormat parameter identifies the encoding (if any) of the data. Possible value are:

1 The data is UTF-8 encoded.
2 The data is binary and has no encoding.
10 The data is a pong packet.

The EOM parameter stands for End Of Message. By default the class will fire the on_data_in event as data is received. Larger messages will be fragmented and will cause the event to fire multiple times. When EOM is true within the event this indicates the current fragment is also the final fragment of the message. The component may also be configured to buffer the message internally until the complete message is received. To enable this set BufferMessage to true.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks WebSockets 2020 Python Edition - Version 20.0 [Build 8155]