NCBI C++ ToolKit
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
CPSGL_RequestTracker::CBackgroundTask Class Reference

Search Toolkit Book for CPSGL_RequestTracker::CBackgroundTask

+ Inheritance diagram for CPSGL_RequestTracker::CBackgroundTask:
+ Collaboration diagram for CPSGL_RequestTracker::CBackgroundTask:

Public Member Functions

 CBackgroundTask (CPSGL_RequestTracker *tracker, EPSG_Status item_status, const shared_ptr< CPSG_ReplyItem > &item)
 
 CBackgroundTask (CPSGL_RequestTracker *tracker)
 
EStatus Execute () override
 Do the actual job. More...
 
void OnStatusChange (EStatus old_task_status) override
 Callback to notify on changes in the task status. More...
 
- Public Member Functions inherited from CThreadPool_Task
 CThreadPool_Task (unsigned int priority=0)
 Constructor. More...
 
void RequestToCancel (void)
 Cancel the task. More...
 
bool IsCancelRequested (void) const
 Check if cancellation of the task was requested. More...
 
EStatus GetStatus (void) const
 Get status of the task. More...
 
bool IsFinished (void) const
 Check if task execution has been already finished (successfully or not) More...
 
unsigned int GetPriority (void) const
 Get priority of the task. More...
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (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
 

Static Public Member Functions

static bool s_IsFinished (EStatus status)
 
static bool s_IsAborted (EStatus status)
 
- 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)
 

Public Attributes

CRef< CPSGL_RequestTrackerm_Tracker
 
EPSG_Status m_ItemStatus
 
shared_ptr< CPSG_ReplyItemm_Item
 

Additional Inherited Members

- Public Types inherited from CThreadPool_Task
enum  EStatus {
  eIdle , eQueued , eExecuting , eCompleted ,
  eFailed , eCanceled
}
 Status of the task. 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< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 
- 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 CThreadPool_Task
virtual void OnCancelRequested (void)
 Callback to notify when cancellation of the task is requested. More...
 
 CThreadPool_Task (const CThreadPool_Task &other)
 Copy ctor. More...
 
CThreadPool_Taskoperator= (const CThreadPool_Task &other)
 Assignment. More...
 
CThreadPoolGetPool (void) const
 The thread pool which accepted this task for execution. More...
 
virtual ~CThreadPool_Task (void)
 Destructor. Will be called from CRef. More...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

Definition at line 221 of file psg_evloop.cpp.

Constructor & Destructor Documentation

◆ CBackgroundTask() [1/2]

CPSGL_RequestTracker::CBackgroundTask::CBackgroundTask ( CPSGL_RequestTracker tracker,
EPSG_Status  item_status,
const shared_ptr< CPSG_ReplyItem > &  item 
)
inline

Definition at line 224 of file psg_evloop.cpp.

◆ CBackgroundTask() [2/2]

CPSGL_RequestTracker::CBackgroundTask::CBackgroundTask ( CPSGL_RequestTracker tracker)
inlineexplicit

Definition at line 233 of file psg_evloop.cpp.

Member Function Documentation

◆ Execute()

EStatus CPSGL_RequestTracker::CBackgroundTask::Execute ( )
inlineoverridevirtual

Do the actual job.

Called by whichever thread handles this task.

Returns
Result of task execution (the status will be set accordingly)
Note
Only 3 values are allowed: eCompleted, eFailed, eCanceled.

Implements CThreadPool_Task.

Definition at line 248 of file psg_evloop.cpp.

References CPSGL_RequestTracker::BackgroundProcessItemCallback(), CPSGL_RequestTracker::BackgroundProcessReplyCallback(), m_Item, m_ItemStatus, and m_Tracker.

◆ OnStatusChange()

void CPSGL_RequestTracker::CBackgroundTask::OnStatusChange ( EStatus  old)
inlineoverridevirtual

Callback to notify on changes in the task status.

Parameters
oldTask status before the change. Current value can be obtained from GetStatus().
Note
Status eQueued is set before task is actually pushed to the queue. After eQueued status eIdle can appear if insertion into the queue failed because of timeout. Status eCanceled will be set only in 2 cases:
See also
OnCancelRequested(), IsCancelRequested(), GetStatus()

Reimplemented from CThreadPool_Task.

Definition at line 258 of file psg_evloop.cpp.

References m_Tracker, and CPSGL_RequestTracker::OnStatusChange().

◆ s_IsAborted()

static bool CPSGL_RequestTracker::CBackgroundTask::s_IsAborted ( EStatus  status)
inlinestatic

◆ s_IsFinished()

static bool CPSGL_RequestTracker::CBackgroundTask::s_IsFinished ( EStatus  status)
inlinestatic

Member Data Documentation

◆ m_Item

shared_ptr<CPSG_ReplyItem> CPSGL_RequestTracker::CBackgroundTask::m_Item

Definition at line 265 of file psg_evloop.cpp.

Referenced by Execute().

◆ m_ItemStatus

EPSG_Status CPSGL_RequestTracker::CBackgroundTask::m_ItemStatus

Definition at line 264 of file psg_evloop.cpp.

Referenced by Execute().

◆ m_Tracker

CRef<CPSGL_RequestTracker> CPSGL_RequestTracker::CBackgroundTask::m_Tracker

Definition at line 263 of file psg_evloop.cpp.

Referenced by Execute(), and OnStatusChange().


The documentation for this class was generated from the following file:
Modified on Fri Sep 20 14:58:16 2024 by modify_doxy.py rev. 669887