DiCE API nvidia_logo_transpbg.gif Up
mi::neuraylib::IShutdown_cluster_callback Class Referenceabstract

Abstract interface for signaling a request to shutdown a cluster. More...

#include <inode_manager.h>

Inheritance diagram for mi::neuraylib::IShutdown_cluster_callback:

Public Member Functions

virtual void shutdown_cluster_callback (const ICluster_descriptor *cluster)=0
 This function is called when a request to shutdown a cluster is being received. More...
 
- Public Member Functions inherited from mi::base::IInterface
virtual Uint32 retain () const =0
 Increments the reference count. More...
 
virtual Uint32 release () const =0
 Decrements the reference count. More...
 
virtual const IInterfaceget_interface (const Uuid &interface_id) const =0
 Acquires a const interface from another. More...
 
template<class T>
const T * get_interface () const
 Acquires a const interface from another. More...
 
virtual IInterfaceget_interface (const Uuid &interface_id)=0
 Acquires a mutable interface from another. More...
 
template<class T>
T * get_interface ()
 Acquires a mutable interface from another. More...
 
virtual Uuid get_iid () const =0
 Returns the interface ID of the most derived interface. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0xadf38762, ... >
typedef Interface_declare< id1, ... > Self
 Own type. More...
 
typedef Uuid_t< id1, ... > IID
 Declares the interface ID (IID) of this interface. More...
 
- Public Types inherited from mi::base::IInterface
typedef Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0> IID
 Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0xadf38762, ... >
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 
- Static Public Member Functions inherited from mi::base::IInterface
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface. More...
 

Detailed Description

Abstract interface for signaling a request to shutdown a cluster.

Its aim is to be derived from by the application writer. The concrete implementation can then be registered with the DiCE API and will after that be used by the DiCE 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 DiCE.

Member Function Documentation

 shutdown_cluster_callback()

virtual void mi::neuraylib::IShutdown_cluster_callback::shutdown_cluster_callback ( const ICluster_descriptor cluster)
pure virtual

This function is called when a request to shutdown a cluster is being received.

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