vrClusterService

class vrClusterService

(Inherits vrBaseService)

A service to control cluster functions.

For cluster rendering a VREDClusterServer process is started on each cluster PC. A raytracing cluster is created by connecting multiple Servers with the master process. The master process is VREDPro or each other VRED product that supports clustering.

Starting a raytracing cluster

vrClusterService.setConfig("pc1 pc2 192.168.178.46")
vrClusterService.start()
# raytracing is done on pc1 pc2 and 192.168.178.46
vrClusterService.stop()

Functions

vrClusterService.abortProgress()

Abort a running connection process.

vrClusterService.getAllowMultipleServers()
Returns:True, if starting multiple servers on the same machine is allowed
Return type:bool
vrClusterService.getConfig()
Returns:Returns the current cluster xml configuration
Return type:string
vrClusterService.getConsumptionBasedLicensing()
Returns:True, if consumption based licensing is enabled
Return type:bool
vrClusterService.getIgnoreNotEnoughMemory()
Returns:True, if memory consumption is not checked on the server
Return type:bool
vrClusterService.getLocalLicenseCheckout()
Returns:True, if all licenses are checked out locally
Return type:bool
vrClusterService.getRunningNodes()
Returns:Returns a list of all connected cluster nodes
Return type:List[string]
vrClusterService.getShowTestImage()
Returns:Returns the True, if test image mode is enabled
Return type:bool
vrClusterService.getShowTiles()
Returns:Returns the True, if tile visualization is enabled
Return type:bool
vrClusterService.hasLicense()
Returns:Returns the True, if all nodes have a valid license
Return type:bool
vrClusterService.hostListToConfig(hostList)

Converts a host list to a xml configuration.

Parameters:hostList (string) – A list of host names
Returns:A xml configuraiton
Return type:string
vrClusterService.isRestarting()
Returns:Returns True, if the cluster is in restarting mode
Return type:bool
vrClusterService.isRunning()
Returns:Returns True, if the cluster is running
Return type:bool
vrClusterService.loadConfig(fileName)

Load a configuration from file.

Parameters:fileName (string) – The file name of a configuration
Returns:True, if the file was loaded successfully
Return type:bool
vrClusterService.runSpeedTest()

Perform a network speed test for the currently running cluster.

Returns:
Return type:List[string]
vrClusterService.setAllowMultipleServers(value)

Set behavior, if a server is already used.

Multiple servers on the same cluster pc are detected, if the same pc is used for example by two differnt VREDPro instances.

Parameters:value (bool) – If True, allow using the server
vrClusterService.setConfig(configuration)

Change the cluster configuration.

The configuration can be a valid vhpc xml file or a list of host names or ip addresses separated by space or comma

Parameters:configuration (string) – The configuration string
vrClusterService.setConsumptionBasedLicensing(value)

Controls, if consumption based licensing is enabled.

Parameters:value (bool) – If True, consumpton based licensing is used
vrClusterService.setDefaultConfig()

Reset the cluster configuration to its default value.

vrClusterService.setEyeSeparation(value)

Set eye separation for display clusters.

Parameters:value (float) – Eye separation
vrClusterService.setIgnoreNotEnoughMemory(value)

Set behavior, if a server has not enough memory.

When a cluster server is started, VRED checks if the cluster server has enough memory left to load the current project. It is asumed thet the cluster PC will use the same amount of memory as the VRED host.

Parameters:value (bool) – If True, allow using the server
vrClusterService.setLocalLicenseCheckout(value)

Controls, where licenses are checked out for clustering.

Parameters:value (bool) – If True, licenses are checked out locally. If False, licenses are checked out by the cluster servers
vrClusterService.setShowTestImage(value)

Show or hide a test image on display clusters.

Parameters:value (bool) – If true, show the test image
vrClusterService.setShowTiles(value)

Show or hide cluster tiles in render window for debugging.

Parameters:value (bool) – If true, show the tile borders
vrClusterService.setZeroParallax(value)

Set zero parallax distance for display clusters.

Parameters:value (float) – Zero Parallax
vrClusterService.start()

Start cluster with current configuration.

Starts the culster with the current configuration A warning will be shown, if there are already servers running or if the estimated memory is not available on the server. This cen be ignored by calling setAllowMultipleServers and setIgnoreNotEnoughMemory

Returns:True, if started successfully
Return type:bool
vrClusterService.stop()

Stop cluster.

Signals

vrClusterService.configChanged(config)

Signal indicates a cluster configuraiton change.

Parameters:config (string) – The changed configuration
vrClusterService.multipleServersFound(hosts)

Signal indicates hosts already used by other users.

Parameters:hosts (List[string]) – List of already used hosts
vrClusterService.notEnoughMemoryFound(hosts)

Signal indicates hosts with insufficient memory.

Parameters:hosts (List[string]) – List of hosts
vrClusterService.progressChanged(action, progress)

Signal can be used to monitor the connection progress.

Parameters:
  • action (string) – A string descripting the current action
  • progress (integer) – The current progress
vrClusterService.progressFinished()

Signal indicates that the connection process is finished.

vrClusterService.runningNodesChanged()

Signal is emitted when one or more cluster nodes have gone offline.

vrClusterService.started()

Signal is emitted after a cluster has been started.

vrClusterService.stopped()

Signal is emitted after a cluster has been stopped.