smartinspectpython.siprotocolcommand

Module: siprotocolcommand.py

Revision History

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

@export
class SIProtocolCommand:

Represents a custom protocol action command as used by the SIProtocol.Dispatch method.

This class is used by custom protocol actions. For detailed information about custom protocol actions, please refer to the SIProtocol.Dispatch and SmartInspect.Dispatch methods.

Threadsafety:

The public members of this class are thread-safe.

SIProtocolCommand(action: int, state: object)

Initializes a new instance of the class.

Arguments:
  • action (int): The custom protocol action to execute.
  • state (object): Optional object which provides additional information about the custom protocol action.
Action: int

Gets the Action property value.

Returns the custom protocol action to execute. The value of this property is protocol specific.

State: object

Gets the State property value.

Returns the optional protocol command object which provides additional information about the custom protocol action. This property can be null.