5.3.1.17.2.1. cli.com.com_interface.ComInterface

class cli.com.com_interface.ComInterface(name: str)

Bases: object

Base class for communication interfaces. Manages process control, logging, and process lifecycle for communication backends.

is_alive(process_name: str | None = None) → bool

Check whether the managed process or all processes are still alive.

Parameters:

process_name (str | None) – Name of the process to check. If None, checks all.

Returns:

True if the specified process (or all) is alive, False otherwise.

Return type:

bool

shutdown(block: bool = False, timeout: int | None = None) → None

Signals all processes to shut down and optionally waits until they have finished.

Parameters:
  • block (bool) – If True, blocks until all processes have terminated or timeout is reached.

  • timeout (int | None) – Maximum time to wait in seconds if blocking. None means indefinite.

start() → None

Start all managed processes and wait until they are ready. Also start the logging listener.

Raises:

ChildProcessError – If a process terminates during initialization.