IPWorks EDI 2020 Python Edition

Questions / Feedback?

on_pi_trail Event

Fired when any protocol level communication occurs.

Syntax

class OFTPClientPITrailEventParams(object):
  @property
  def direction() -> int: ...
  @property
  def data() -> bytes: ...
  @property
  def command_id() -> int: ...
  @property
  def command_description() -> str: ...

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

Remarks

This event provides information about the protocol level communication between the client and server.

The Direction parameter specifies who sent the command.

0 (Client) The command originated from the connected client.
1 (Server) The command originated from the server.

The CommandId and CommandDescription parameters specify which command was sent. The table below shows possible values.

CommandIdCommandDescription
50SFPA (Start File Positive Answer)
51SFNA (Start File Negative Answer)
52EFPA (End File Positive Answer)
53EFNA (End File Negative Answer)
65AUCH (Authentication Challenge)
67CDT (Set Credit)
68DATA (Data Exchange Buffer)
69EERP (End to End Response)
70ESID (End Session)
72SFID (Start File)
73SSRM (Start Session Ready Message)
74SECD (Security Change Direction)
78NERP (Negative End Response)
80RTR (Ready To Receive)
82CD (Change Direction)
83AURP (Authentication Response)
84EFID (End File)
88SSID (Start Session)

The Data parameter contains the raw OFTP packet.

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