DtAsyncJobMapEntry Class Reference

Handle to async job. More...

Inheritance diagram for DtAsyncJobMapEntry:

Public Member Functions
	DtAsyncJobMapEntry (DtAsyncJobServer *)
virtual	~DtAsyncJobMapEntry ()
	Automatically removes self from server map.
virtual size_t	id ()
	Server-wide id.
virtual DtAsyncJobServer &	server ()
	Job server.
virtual DtAsyncJobStatus	status () const
	Get status.
virtual const DtAsyncJobResult *	result () const
	Get result.
virtual void	setStatus (DtAsyncJobStatus status)
	Set status.
virtual void	setResult (DtAsyncJobStatus status, DtAsyncJobResult *result=0)
	Set result (takes ownership of result).

Protected Types
typedef tbb::spin_rw_mutex	Mutex

Protected Attributes
Mutex	myMutex
DtAsyncJobServer *	myServer
size_t	myId
DtAsyncJobStatus	myStatus
std::auto_ptr< DtAsyncJobResult >	myResult

Additional Inherited Members
Static Public Member Functions inherited from DtObjectDebugger< DtAsyncJobMapEntry >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()
Protected Member Functions inherited from DtObjectDebugger< DtAsyncJobMapEntry >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Detailed Description

Handle to async job.

This class is designed to be stored by shared pointer by the user. The instance is connected to the actual job object by the server which holds a weak pointer to this object. When the user no longer needs the job they can delete the shared pointer which will delete the job entry. The job can then check for this.

Member Typedef Documentation

typedef tbb::spin_rw_mutex DtAsyncJobMapEntry::Mutex

protected

Constructor & Destructor Documentation

DtAsyncJobMapEntry::DtAsyncJobMapEntry ( DtAsyncJobServer *  )

explicit

virtual DtAsyncJobMapEntry::~DtAsyncJobMapEntry ( )

virtual

Automatically removes self from server map.

Member Function Documentation

virtual size_t DtAsyncJobMapEntry::id ( )

virtual

Server-wide id.

virtual DtAsyncJobServer& DtAsyncJobMapEntry::server ( )

virtual

Job server.

virtual DtAsyncJobStatus DtAsyncJobMapEntry::status ( ) const

virtual

Get status.

virtual const DtAsyncJobResult* DtAsyncJobMapEntry::result ( ) const

virtual

Get result.

virtual void DtAsyncJobMapEntry::setStatus ( DtAsyncJobStatus  status )

virtual

Set status.

virtual void DtAsyncJobMapEntry::setResult ( DtAsyncJobStatus  status, DtAsyncJobResult *  result = 0  )

virtual

Set result (takes ownership of result).

Member Data Documentation

Mutex DtAsyncJobMapEntry::myMutex

mutableprotected

DtAsyncJobServer* DtAsyncJobMapEntry::myServer

protected

size_t DtAsyncJobMapEntry::myId

protected

DtAsyncJobStatus DtAsyncJobMapEntry::myStatus

protected

std::auto_ptr<DtAsyncJobResult> DtAsyncJobMapEntry::myResult

protected

---

The documentation for this class was generated from the following file:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrfutil/asyncJobMapEntry.h