Search Toolkit Book for CJobFutureJobBase
#include <gui/utils/job_future.hpp>
Inheritance diagram for CJobFutureJobBase:
Collaboration diagram for CJobFutureJobBase:
Public Member Functions | |
| CJobFutureJobBase (const string &descr) | |
IAppJob implementation | |
| virtual string | GetDescr () const |
| Returns a human readable description of the Job (optional) More... | |
| virtual CConstIRef< IAppJobProgress > | GetProgress () |
| return progress object, the function shall be synchronized internally. More... | |
| virtual CRef< CObject > | GetResult () |
| Returns the Job Result. More... | |
| virtual CConstIRef< IAppJobError > | GetError () |
| Returns IAppJobError object describing internal error that caused the Job to fail. More... | |
| Public Member Functions inherited from CJobCancelable | |
| CJobCancelable () | |
| void | SetDataLocker (ILocker *locker) |
| virtual void | RequestCancel () override |
| RequestCancel() is called to notify the Job that it shall exit Run() function ASAP. More... | |
| virtual bool | IsCanceled () const override |
| Public Member Functions inherited from CObject | |
| CObject (void) | |
| Constructor. More... | |
| CObject (const CObject &src) | |
| Copy constructor. More... | |
| virtual | ~CObject (void) |
| Destructor. More... | |
| CObject & | operator= (const CObject &src) THROWS_NONE |
| Assignment operator. More... | |
| bool | CanBeDeleted (void) const THROWS_NONE |
| Check if object can be deleted. More... | |
| bool | IsAllocatedInPool (void) const THROWS_NONE |
| Check if object is allocated in memory pool (not system heap) More... | |
| bool | Referenced (void) const THROWS_NONE |
| Check if object is referenced. More... | |
| bool | ReferencedOnlyOnce (void) const THROWS_NONE |
| Check if object is referenced only once. More... | |
| void | AddReference (void) const |
| Add reference to object. More... | |
| void | RemoveReference (void) const |
| Remove reference to object. More... | |
| void | ReleaseReference (void) const |
| Remove reference without deleting object. More... | |
| virtual void | DoNotDeleteThisObject (void) |
| Mark this object as not allocated in heap – do not delete this object. More... | |
| virtual void | DoDeleteThisObject (void) |
| Mark this object as allocated in heap – object can be deleted. More... | |
| void * | operator new (size_t size) |
| Define new operator for memory allocation. More... | |
| void * | operator new[] (size_t size) |
| Define new[] operator for 'array' memory allocation. More... | |
| void | operator delete (void *ptr) |
| Define delete operator for memory deallocation. More... | |
| void | operator delete[] (void *ptr) |
| Define delete[] operator for memory deallocation. More... | |
| void * | operator new (size_t size, void *place) |
| Define new operator. More... | |
| void | operator delete (void *ptr, void *place) |
| Define delete operator. More... | |
| void * | operator new (size_t size, CObjectMemoryPool *place) |
| Define new operator using memory pool. More... | |
| void | operator delete (void *ptr, CObjectMemoryPool *place) |
| Define delete operator. More... | |
| virtual void | DebugDump (CDebugDumpContext ddc, unsigned int depth) const |
| Define method for dumping debug information. More... | |
| Public Member Functions inherited from CDebugDumpable | |
| CDebugDumpable (void) | |
| virtual | ~CDebugDumpable (void) |
| void | DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const |
| void | DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const |
| void | DumpToConsole (void) const |
| Public Member Functions inherited from IAppJob | |
| virtual | ~IAppJob () |
| virtual bool | BeforeRun () |
| Function will be called on the main thread before execution of Run Should not do any lengthy work returns true to continue job execution on worker thread false to quit execution with status - failed. More... | |
| virtual EJobState | Run ()=0 |
| Function that does all the useful work, called by the Engine. More... | |
Protected Member Functions | |
| virtual string | x_GetJobName () const |
| Protected Member Functions inherited from CJobCancelable | |
| CLockerGuard | x_GetGuard () |
| ICanceled * | x_GetICanceled () |
| Protected Member Functions inherited from CObject | |
| virtual void | DeleteThis (void) |
| Virtual method "deleting" this object. More... | |
Protected Attributes | |
| string | m_Descr |
| CRef< CObject > | m_Result |
| CConstRef< CJobFutureError > | m_Error |
Additional Inherited Members | |
| Public Types inherited from CObject | |
| enum | EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern } |
| Control filling of newly allocated memory. More... | |
| typedef CObjectCounterLocker | TLockerType |
| Default locker type for CRef. More... | |
| typedef atomic< Uint8 > | TCounter |
| Counter type is CAtomiCounter. More... | |
| typedef Uint8 | TCount |
| Alias for value type of counter. More... | |
| Public Types inherited from IAppJob | |
| enum | EJobState { eInvalid , eRunning , eCompleted , eFailed , eCanceled , eSuspended } |
| Job states (describe FSM) More... | |
| Static Public Member Functions inherited from CObject | |
| static NCBI_XNCBI_EXPORT void | ThrowNullPointerException (void) |
| Define method to throw null pointer exception. More... | |
| static NCBI_XNCBI_EXPORT void | ThrowNullPointerException (const type_info &type) |
| static EAllocFillMode | GetAllocFillMode (void) |
| static void | SetAllocFillMode (EAllocFillMode mode) |
| static void | SetAllocFillMode (const string &value) |
| Set mode from configuration parameter value. More... | |
| Static Public Member Functions inherited from CDebugDumpable | |
| static void | EnableDebugDump (bool on) |
| Static Public Attributes inherited from CObject | |
| static const TCount | eCounterBitsCanBeDeleted = 1 << 0 |
| Define possible object states. More... | |
| static const TCount | eCounterBitsInPlainHeap = 1 << 1 |
| Heap signature was found. More... | |
| static const TCount | eCounterBitsPlaceMask |
| Mask for 'in heap' state flags. More... | |
| static const int | eCounterStep = 1 << 2 |
| Skip over the "in heap" bits. More... | |
| static const TCount | eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2) |
| Minimal value for valid objects (reference counter is zero) Must be a single bit value. More... | |
| static const TCount | eCounterStateMask |
| Valid object, and object in heap. More... | |
Detailed Description
Definition at line 312 of file job_future.hpp.
Constructor & Destructor Documentation
◆ CJobFutureJobBase()
Definition at line 315 of file job_future.hpp.
Member Function Documentation
◆ GetDescr()
|
inlinevirtual |
Returns a human readable description of the Job (optional)
Implements IAppJob.
Definition at line 319 of file job_future.hpp.
References m_Descr.
◆ GetError()
|
inlinevirtual |
Returns IAppJobError object describing internal error that caused the Job to fail.
Result shall be returned only if the Job did fail.
Implements IAppJob.
Definition at line 328 of file job_future.hpp.
References CConstRef< C, Locker >::GetPointer(), and m_Error.
◆ GetProgress()
|
inlinevirtual |
return progress object, the function shall be synchronized internally.
the returned object should not be modified by the job (job shall create a new instance of Progress object on every GetProgress() invocation).
Implements IAppJob.
Definition at line 320 of file job_future.hpp.
◆ GetResult()
Returns the Job Result.
Derive your own object from CObject and return it from your Job class. Result shall be returned only if Job finished succesfully.
Implements IAppJob.
Definition at line 324 of file job_future.hpp.
References m_Result.
◆ x_GetJobName()
|
inlineprotectedvirtual |
Definition at line 335 of file job_future.hpp.
References m_Descr.
Member Data Documentation
◆ m_Descr
|
protected |
Definition at line 337 of file job_future.hpp.
Referenced by GetDescr(), and x_GetJobName().
◆ m_Error
|
protected |
Definition at line 339 of file job_future.hpp.
Referenced by GetError(), and CJobFutureJob< _Fty, void >::Run().
◆ m_Result
Definition at line 338 of file job_future.hpp.
Referenced by GetResult(), and CJobFutureJob< _Fty, void >::Run().
The documentation for this class was generated from the following file:
- include/gui/utils/job_future.hpp
