VR-Forces 5.0.3 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Types | Protected Attributes
DtAsyncJobMapEntry Class Reference

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.

Public Member Functions

 DtAsyncJobMapEntry (DtAsyncJobServer *)
 
virtual ~DtAsyncJobMapEntry ()
 
virtual size_t id ()
 
virtual DtAsyncJobServerserver ()
 
virtual DtAsyncJobStatus status () const
 
virtual const DtAsyncJobResultresult () const
 
virtual void setStatus (DtAsyncJobStatus status)
 
virtual void setResult (DtAsyncJobStatus status, DtAsyncJobResult *result=0)
 

Protected Types

typedef tbb::spin_rw_mutex Mutex
 

Protected Attributes

Mutex myMutex
 
DtAsyncJobServermyServer
 
size_t myId
 
DtAsyncJobStatus myStatus
 
std::auto_ptr< DtAsyncJobResultmyResult
 

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:

Document ID: Generated on Thu Jun 1 17:58:13 EDT 2023 from SVN revision 255404
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)