mi::neuraylib::IReady_callback Class Reference

Abstract interface to report completion of an asynchronous operation back to the caller. More...

#include <iready_callback.h>

Inheritance diagram for mi::neuraylib::IReady_callback:

Public Member Functions
virtual void	ready (Sint32 result)=0
	The callback method that signals the completion of the asynchronous operation. 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 IInterface *	get_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 IInterface *	get_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< 0x5c4ecccf, ... >
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< 0x5c4ecccf, ... >
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 to report completion of an asynchronous operation back to the caller.

Typically, an instance of this interface is passed to methods triggering asynchronous operations. After completion of the operation the ready() method of this instance is called to report completion of the asynchronous operation to the caller.

For example, an instance of this interface can be passed to mi::neuraylib::IRender_context::render_async().

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 the Iray library.

Member Function Documentation

ready()

virtual void mi::neuraylib::IReady_callback::ready ( Sint32  result )

pure virtual

The callback method that signals the completion of the asynchronous operation.

It can be called at any time from any thread.

Note

You must not call any of following methods from within the callback:

• mi::neuraylib::ITransaction::commit() or mi::neuraylib::ITransaction::abort() on the transaction associated with the progress callback.

Parameters

result

Result of the asynchronous operation. See the documentation of the asynchronous operation for the meaning of the value.