NVIDIA Iray API Home  Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::neuraylib::ICluster_manager_cluster Class Referenceabstract

Represents a cluster which was reserved through the cluster manager. More...

Inheritance diagram for mi::neuraylib::ICluster_manager_cluster:
Inheritance graph
[legend]

Public Member Functions

virtual const char *  get_head_node ()=0
  Returns the address of the head node of 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. More...
 
virtual const char *  get_bridge_protocol_version ()=0
  Returns the Bridge protocol version of the cluster. More...
 
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 bool  is_compatible ()=0
  Indicates whether server's Bridge protocol version is compatible with the client's Bridge protocol version. More...
 
virtual Size  get_number_of_cluster_nodes ()=0
  Returns the number of nodes in the cluster. More...
 
virtual ICluster_manager_node get_cluster_node (Size index)=0
  Returns a node which is part of the cluster. More...
 
virtual bool  can_be_closed ()=0
  Indicates if the cluster can be closed by the application through this API. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x5c88e256, 0x6d61, 0x4d76, 0x91, 0x13, 0xe0, 0x37, 0x9f, 0x4a, 0xfd, 0x07 >
typedef Interface_declare< id1,
id2, id3, id4, id5, id6, id7,
id8, id9, id10, id11,
IInterface
Self
  Own type. More...
 
typedef Uuid_t< id1, id2, id3,
id4, id5, id6, id7, id8, id9,
id10, id11 > 
IID
  Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0x5c88e256, 0x6d61, 0x4d76, 0x91, 0x13, 0xe0, 0x37, 0x9f, 0x4a, 0xfd, 0x07 >
static bool  compare_iid (const Uuid &iid)
  Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 

Detailed Description

Represents a cluster which was reserved through the cluster manager.

See Also
mi::neuraylib::ICluster_manager_connection::reserve_cluster()

Member Function Documentation

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

Returns a node which is part of the cluster.

See Also
get_number_of_cluster_nodes()
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

Returns the number of nodes in the cluster.

See Also
get_cluster_node()
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.