Search Toolkit Book for CScheduler_QueueEvent
Class storing full information about scheduled event for task execution. More...
Inheritance diagram for CScheduler_QueueEvent:
Collaboration diagram for CScheduler_QueueEvent:
Public Types | |
| enum | ERepeatPattern { eWithRate = IScheduler::eWithRate , eWithDelay = IScheduler::eWithDelay , eNoRepeat } |
| How to run repetitive tasks including not repeating at all. More... | |
| 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 Member Functions | |
| bool | IsMatch (TScheduler_SeriesID match_id) const |
| Check if this event matches given series id. More... | |
| bool | IsMatch (IScheduler_Task *match_task) const |
| Check if this event matches given task. More... | |
| bool | IsMatch (bool dummy_val) const |
| Dummy function to support code templates and avoid duplication of code. More... | |
| CScheduler_QueueEvent () | |
| 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 Attributes | |
| TScheduler_SeriesID | id |
| Id of the series. More... | |
| CIRef< IScheduler_Task > | task |
| Task itself. More... | |
| CTime | exec_time |
| Time when this event will be executed. More... | |
| CTimeSpan | period |
| Period of repetitive execution of the task. More... | |
| ERepeatPattern | repeat_pattern |
| Repeating pattern of the task. More... | |
Additional Inherited Members | |
| 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... | |
| Protected Member Functions inherited from CObject | |
| virtual void | DeleteThis (void) |
| Virtual method "deleting" this object. More... | |
Detailed Description
Class storing full information about scheduled event for task execution.
Definition at line 48 of file scheduler.cpp.
Member Enumeration Documentation
◆ ERepeatPattern
How to run repetitive tasks including not repeating at all.
- See also
- IScheduler::ERepeatPattern
Definition at line 62 of file scheduler.cpp.
Constructor & Destructor Documentation
◆ CScheduler_QueueEvent()
|
inline |
Definition at line 99 of file scheduler.cpp.
Member Function Documentation
◆ IsMatch() [1/3]
Dummy function to support code templates and avoid duplication of code.
Definition at line 91 of file scheduler.cpp.
◆ IsMatch() [2/3]
|
inline |
Check if this event matches given task.
Definition at line 85 of file scheduler.cpp.
◆ IsMatch() [3/3]
|
inline |
Check if this event matches given series id.
Definition at line 79 of file scheduler.cpp.
Member Data Documentation
◆ exec_time
| CTime CScheduler_QueueEvent::exec_time |
Time when this event will be executed.
Definition at line 56 of file scheduler.cpp.
Referenced by CScheduler_MT::GetNextTaskToExecute(), PScheduler_QueueEvent_Compare::operator()(), and CScheduler_MT::x_AddQueueTask().
◆ id
| TScheduler_SeriesID CScheduler_QueueEvent::id |
Id of the series.
Definition at line 52 of file scheduler.cpp.
Referenced by CScheduler_MT::GetNextTaskToExecute(), CScheduler_MT::TaskExecuted(), and CScheduler_MT::x_AddQueueTask().
◆ period
| CTimeSpan CScheduler_QueueEvent::period |
Period of repetitive execution of the task.
Definition at line 58 of file scheduler.cpp.
Referenced by CScheduler_MT::GetNextTaskToExecute(), CScheduler_MT::TaskExecuted(), and CScheduler_MT::x_AddQueueTask().
◆ repeat_pattern
| ERepeatPattern CScheduler_QueueEvent::repeat_pattern |
Repeating pattern of the task.
Definition at line 75 of file scheduler.cpp.
Referenced by CScheduler_MT::GetNextTaskToExecute(), CScheduler_MT::TaskExecuted(), and CScheduler_MT::x_AddQueueTask().
◆ task
| CIRef<IScheduler_Task> CScheduler_QueueEvent::task |
Task itself.
Definition at line 54 of file scheduler.cpp.
Referenced by CScheduler_MT::GetNextTaskToExecute(), CScheduler_MT::TaskExecuted(), and CScheduler_MT::x_AddQueueTask().
The documentation for this class was generated from the following file:
- src/util/scheduler.cpp
