IPWorks IoT 2020 Python Edition

Questions / Feedback?

on_pi_trail Event

This event is fired for all protocol messages.

Syntax

class XMPPPITrailEventParams(object):
  @property
  def direction() -> int: ...
  @property
  def pi() -> str: ...

# In class XMPP:
@property
def on_pi_trail() -> Callable[[XMPPPITrailEventParams], None]: ...
@on_pi_trail.setter
def on_pi_trail(event_hook: Callable[[XMPPPITrailEventParams], None]) -> None: ...

Remarks

The on_pi_trail event is useful for debugging purposes. It shows all the interaction between the client and the server, line by line.

SessionId will hold the session number that originated the PI. A value of 0 is reserved for all PI dealing with the im_server.

The direction parameter shows the originator of the message:

0 (Client)Pi originates from the client.
1 (Server)Pi originates from the server.
2 (Info)Pi is an informative message originating from within the class.

The Pi parameter contains the PI message.

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