IPWorks WebSockets 2020 Python Edition

Questions / Feedback?

on_log Event

Fires once for each log message.

Syntax

class WebSocketClientLogEventParams(object):
  @property
  def log_level() -> int: ...
  @property
  def message() -> str: ...
  @property
  def log_type() -> str: ...

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

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data is logged.
3 (Debug) Debug data is logged.

The value 1 (Info) logs basic information including the URL, HTTP version, and connection status details.

The value 2 (Verbose) logs additional information about the initial HTTP request.

The value 3 (Debug) logs additional debug information (if available).

Message is the log entry.

LogType identifies the type of log entry. Possible values are:

  • "Info"
  • "Error"
  • "Verbose"
  • "Debug"

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