• OctoMY API
  • OctoMY API Reference
  • C++ Classes
  • OctoMY
  • SerialDeleteConnectionTask
  • SerialDeleteConnectionTask Class

    OpalTask: remove a saved SerialConnection from the active node. More...

    Header: #include <SerialDeleteConnectionTask>
    Since: 1.0
    Inherits: OpalTask

    Detailed Description

    Carries the serial.config permission scope. Idempotent — deleting a non-existent id is a no-op success because the post-condition (connection is gone) is already met.

    force=true closes any active session via the manager before removing the connection (wired in P4 once the session manager exists). Without force, an open-session delete is refused with a "pass force=true or run serial.close first" suggestion.

    See also OpalTask.