watchdog

Module for launching the PyCFX Watchdog to monitor the PyCFX and the CFX server.

This module should not be used manually. PyCFX automatically manages it. For more information, see the start_watchdog argument for the launch_cfx() function.

Exceptions:

UnsuccessfulWatchdogLaunch

Raised when Watchdog launch is unsuccessful.

Functions:

launch(main_pid, sv_port, sv_password[, sv_ip])

Function to launch the Watchdog.

exception ansys.cfx.core.launcher.watchdog.UnsuccessfulWatchdogLaunch

Bases: RuntimeError

Raised when Watchdog launch is unsuccessful.

ansys.cfx.core.launcher.watchdog.launch(main_pid: int, sv_port: int, sv_password: str, sv_ip: str | None = None) → None

Function to launch the Watchdog. This function is automatically used and managed by PyCFX.

Parameters:

main_pidint

Process ID of the Python interpreter used to launch PyCFX and the Watchdog.

sv_portint

CFX server port number.

sv_passwordstr

CFX server password.

sv_ipstr, optional

CFX server IP address.

Raises:

UnsuccessfulWatchdogLaunch

If Watchdog fails to launch.