mi::neuraylib::ICluster_manager_cluster Class Reference
[Cluster manager]
Description
Represents a cluster which was reserved through the cluster manager.
See also:
mi::neuraylib::ICluster_manager_connection::reserve_cluster()
Public Member Functions
- virtual bool can_be_closed() =0
- Indicates if the cluster can be closed by the application through this API.
- virtual const char* get_authentication_token() =0
- Returns an authentication token which has to be provided by the Bridge client when making the connection. More...
- virtual const char* get_bridge_protocol_version() =0
- Returns the Bridge protocol version of the cluster. More...
- virtual ICluster_manager_node* get_cluster_node( Size index) =0
- Returns a node which is part of the cluster. More...
- virtual const char* get_head_node() =0
- Returns the address of the head node of the cluster.
- virtual Size get_number_of_cluster_nodes() =0
- Returns the number of nodes in the cluster. More...
- virtual const char* get_software_package_id() =0
- Returns the ID of software package which was started on the cluster, or NULL if no software was started.
- virtual bool is_compatible() =0
- Indicates whether server's Bridge protocol version is compatible with the client's Bridge protocol version.
Member Functions
- virtual bool mi::neuraylib::ICluster_manager_cluster::can_be_closed() [pure virtual]
-
Indicates if the cluster can be closed by the application through this API.
- virtual const char* mi::neuraylib::ICluster_manager_cluster::get_authentication_token() [pure virtual]
-
Returns an authentication token which has to be provided by the Bridge client when making the connection. The token was generated by the cluster manager and has been passed to the software started on the server side.
- virtual const char* mi::neuraylib::ICluster_manager_cluster::get_bridge_protocol_version() [pure virtual]
-
Returns the Bridge protocol version of the cluster. This is for display purposes only. Use is_compatible() to check whether it is compatible with the client's Bridge protocol version.
- virtual ICluster_manager_node* mi::neuraylib::ICluster_manager_cluster::get_cluster_node( Size index) [pure virtual]
-
Parameters
- index
- The index of the cluster node.
Returns
A description of the index-th cluster node, or NULL if index is out of bounds.
- virtual const char* mi::neuraylib::ICluster_manager_cluster::get_head_node() [pure virtual]
-
Returns the address of the head node of the cluster.
- virtual Size mi::neuraylib::ICluster_manager_cluster::get_number_of_cluster_nodes() [pure virtual]
- virtual const char* mi::neuraylib::ICluster_manager_cluster::get_software_package_id() [pure virtual]
-
Returns the ID of software package which was started on the cluster, or NULL if no software was started.
- virtual bool mi::neuraylib::ICluster_manager_cluster::is_compatible() [pure virtual]
-
Indicates whether server's Bridge protocol version is compatible with the client's Bridge protocol version.