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

Abstract interface for signaling a change of the cluster application head node. More...

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

Public Member Functions

virtual void  head_node_callback (IWorker_node_descriptor *worker_descriptor)=0
  This function is called when a cluster node becomes cluster head node. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0xf07bba0e, 0x249f, 0x4c6d, 0x97, 0x57, 0x48, 0xa7, 0xf8, 0xe7, 0xe6, 0x5a >
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< 0xf07bba0e, 0x249f, 0x4c6d, 0x97, 0x57, 0x48, 0xa7, 0xf8, 0xe7, 0xe6, 0x5a >
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

Abstract interface for signaling a change of the cluster application head node.

Its aim is to be derived from by the application writer. The concrete implementation can then be registered with the Iray API and will after that be used by the Iray library.

Note
Instances of this interface should not be created on the stack, since this might lead to premature destruction of such instances while still being in use by Iray.
See Also
mi::neuraylib::INode_manager_cluster::get_head_node to retrieve the cluster head node.

Member Function Documentation

virtual void mi::neuraylib::IHead_node_callback::head_node_callback ( IWorker_node_descriptor worker_descriptor)
pure virtual

This function is called when a cluster node becomes cluster head node.

This should not be confused with the head node in TCP networking as it is unrelated.

It should return as soon as possible because it may block further network operations.

Parameters
worker_descriptor The descriptor of the cluster head node.