DiCE API nvidia_logo_transpbg.gif Up
mi::bridge::IServer_job_info Class Referenceabstract

Provides additional information about a bridge job. More...

#include <ibridge_server.h>

Inheritance diagram for mi::bridge::IServer_job_info:

Public Member Functions

virtual IServer_jobget_job () const =0
 Returns the Bridge job instance. More...
 
template<class T>
T * get_job () const
 Returns the Bridge job instance. More...
 
virtual const char * get_id () const =0
 Returns the id of this job. More...
 
virtual base::Uuid get_job_uuid ()=0
 Returns the universally unique identifier (UUID or GUID) of the Bridge job. 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< 0xa28b5525, ... >
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< 0xa28b5525, ... >
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

Provides additional information about a bridge job.

Member Function Documentation

 get_id()

virtual const char * mi::bridge::IServer_job_info::get_id ( ) const
pure virtual

Returns the id of this job.

The id is only guaranteed to be unique among the currently active jobs of the transaction and is suitable only for log messages and the like.

 get_job() [1/2]

template<class T>
T * mi::bridge::IServer_job_info::get_job ( ) const
inline

Returns the Bridge job instance.

This templated member function is a wrapper of the non-template variant for the user's convenience. It eliminates the need to call mi::base::IInterface::get_interface(const Uuid&) on the returned pointer, since the return type already is a pointer to the type T specified as template parameter.

 get_job() [2/2]

virtual IServer_job * mi::bridge::IServer_job_info::get_job ( ) const
pure virtual

Returns the Bridge job instance.

If the job has not been deserialized yet NULL is returned. This is the case if the job data contains tags in which case it can't be deserialized until the server-side database transaction has been started.

 get_job_uuid()

virtual base::Uuid mi::bridge::IServer_job_info::get_job_uuid ( )
pure virtual

Returns the universally unique identifier (UUID or GUID) of the Bridge job.

This will always be available even if the job has not been deserialized yet. The UUID defines the job class and client side and server side job implementations share the same class id.