Configuration of the NVIDIA IndeX cluster environment.
More...
#include <iindex.h>
Inherits mi::base::Interface_declare< 0x84fcac5c, ... >.
Configuration of the NVIDIA IndeX cluster environment.
Interface to set and query the NVIDIA IndeX cluster configuration.
◆ get_host_index()
| virtual mi::Uint32 nv::index::ICluster_configuration::get_host_index |
( |
mi::Uint32 |
index | ) |
const |
|
pure virtual |
Get cluster node id for the given node.
- Parameters
-
| [in] | index | Index into the list of cluster nodes. |
- Returns
- Returns the cluster node id.
◆ get_host_name()
| virtual const char * nv::index::ICluster_configuration::get_host_name |
( |
mi::Uint32 |
host_id | ) |
const |
|
pure virtual |
Get hostname for the given host id.
- Parameters
-
| [in] | host_id | The host id used to query the hostname. |
- Returns
- Returns the hostname of the machine with the given id. Will return 0 if no information about that host is available (yet).
◆ get_local_host_id()
| virtual mi::Uint32 nv::index::ICluster_configuration::get_local_host_id |
( |
| ) |
const |
|
pure virtual |
Get the cluster node id of the local node that the viewer runs on.
- Returns
- Returns the cluster node id of the local node or 0 if the node has not not yet connected to cluster.
◆ get_number_of_compositing_hosts()
| virtual mi::Uint32 nv::index::ICluster_configuration::get_number_of_compositing_hosts |
( |
| ) |
const |
|
pure virtual |
Get number of nodes in the cluster used for distributed, parallel compositing only.
- Returns
- The number of cluster nodes assigned to the compositing service.
◆ get_number_of_GPUs()
| virtual mi::Uint32 nv::index::ICluster_configuration::get_number_of_GPUs |
( |
| ) |
const |
|
pure virtual |
Get number of GPUs in the cluster environment that can be used for cluster-wide rendering and computing.
- Returns
- Returns the number of GPUs present in the cluster environment.
◆ get_number_of_hosts()
| virtual mi::Uint32 nv::index::ICluster_configuration::get_number_of_hosts |
( |
| ) |
const |
|
pure virtual |
Get number of nodes in the cluster used for distributed, parallel rendering and computing.
- Returns
- The number of cluster nodes.
◆ get_number_of_rendering_hosts()
| virtual mi::Uint32 nv::index::ICluster_configuration::get_number_of_rendering_hosts |
( |
| ) |
const |
|
pure virtual |
Get number of nodes in the cluster used for distributed, parallel rendering only.
- Returns
- The number of cluster nodes assigned to the rendering service.
◆ register_callback()
Register a callback that allows notifying the application if the cluster topology has changed.
- Parameters
-
| [in] | callback | The cluster change callback. |
◆ set_automatic_subclustering()
| virtual bool nv::index::ICluster_configuration::set_automatic_subclustering |
( |
mi::Uint32 |
min_sub_cluster_size, |
|
|
mi::Uint32 |
max_nr_of_sub_clusters |
|
) |
| |
|
pure virtual |
Enable automatic subclustering of machines in the entire cluster using DiCE.
- Parameters
-
| [in] | min_sub_cluster_size | Sets the minimum number of machines in a sub-cluster. |
| [in] | max_nr_of_sub_clusters | Sets the number of sub-clusters required. |
- Returns
- Returns
true on success.
◆ set_service_mode()
| virtual bool nv::index::ICluster_configuration::set_service_mode |
( |
const char * |
service_mode | ) |
|
|
pure virtual |
Set the service mode of the present cluster machine.
- Parameters
-
| service_mode | The service mode can be either 'rendering', 'compositing', 'rendering_and_compositing', or 'none'. |
- Returns
- Returns
true on success.
◆ set_sub_cluster_id()
| virtual bool nv::index::ICluster_configuration::set_sub_cluster_id |
( |
mi::Uint32 |
sub_cluster_id | ) |
|
|
pure virtual |
A sub-cluster represents a collections of machines.
The collection of machines represents a subset of the machines in the entire cluster. A sub-cluster enables, for instance, scalable large-scale display support.
- Parameters
-
| [in] | sub_cluster_id | Sets the sub-cluster id of the present cluster machine. |
- Returns
- Returns
true on success.
The documentation for this class was generated from the following file:
