smartinspectpython.siprocessflow

Module: siprocessflow.py

Revision History

Date Version Description
2023/05/30 3.0.0.0 Initial Version.

@export
class SIProcessFlow(smartinspectpython.sipacket.SIPacket):

Represents the Process Flow packet type which is used in the EnterMethod and LeaveMethod methods in the SISession class.

A Process Flow entry is responsible for illustrated process and thread information.

It has several properties which describe its creation context (like a thread ID, time-stamp or hostname) and other properties which specify the way the Console interprets this packet (like the process flow ID). Furthermore a Process Flow entry contains the actual data, namely the title, which will be displayed in the Console.

Threadsafety:

This class is not guaranteed to be thread-safe. However, instances of this class will normally only be used in the context of a single thread.

Initializes a new SIProcessFlow instance with a custom process flow type.

Arguments:
  • processFlowType (SIProcessFlowType): The type of the new Process Flow entry describes the way the Console interprets this packet. Please see the SIProcessFlowType enum for more information.
HEADER_SIZE: int = 28
HostName: str

Gets the HostName property value.

Represents the hostname of this Process Flow entry.

The hostname of this Process Flow entry is usually set to the name of the machine this Process Flow entry is sent from. It will be empty in the SmartInspect Console when this property is set to null.

Overridden. Returns SIPacketType.ProcessFlow

Gets the ProcessFlowType property value.

Represents the type of this Process Flow entry.

The type of the Process Flow entry describes the way the Console interprets this packet. Please see the SIProcessFlowType enum for more information.

ProcessId: int

Gets the ProcessId property value.

Represents the ID of the process this object was created in.

Size: int

Overridden. Returns the total occupied memory size of this Process Flow packet.

The total occupied memory size of this Process Flow is the size of memory occupied by all strings, the optional Data stream and any internal data structures of this Process Flow.

ThreadId: int

Gets the ThreadId property value.

Represents the ID of the thread this object was created in.

Timestamp: datetime.datetime

Gets the Timestamp property value.

Represents the time-stamp of this Log Entry object.

This property returns the creation time of this Log Entry object.

Title: str

Gets the Title property value.

Represents the title of this Process Flow entry.

The title of this Process Flow entry will be empty in the SmartInspect Console when this property is set to null.