Search Toolkit Book for CSchedulerEngine

CSchedulerEngine CSchedulerEngine is an engine that can be used with CAppJobDispatcher. More...

#include <gui/utils/scheduler_engine.hpp>

Inheritance diagram for CSchedulerEngine:

Collaboration diagram for CSchedulerEngine:

Classes
struct	CJobRecord
	record that holds infromation about a job More...

Public Types
typedef IAppJob::EJobState	TJobState

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 IAppJobEngine
typedef CAppJobDispatcher	TDisp

typedef IAppJob::EJobState	TJobState

Public Member Functions
	CSchedulerEngine ()
	CSchedulerEngine. More...

virtual	~CSchedulerEngine ()

IAppJobEngine implementation
virtual bool	IsActive ()
	Returns true if Engine supports "active" model i.e. More...

virtual void	SetListener (IAppJobEngineListener *listener)
	For "active" mode set a Listener that will be notified when the state of a Job changes. More...

void	StartJob (IAppJob &job, IEngineParams *)
	If Engine cannot start the Job and exception shall be thrown. More...

virtual void	CancelJob (IAppJob &job)
	Cancel job in the engine If job is not running yet - just remove from the pending queue otherwise uses IInterruptible to notify the job about cancel request. More...

virtual void	SuspendJob (IAppJob &)

virtual void	ResumeJob (IAppJob &)

virtual TJobState	GetJobState (IAppJob &job) const

virtual void	ShutDown ()
	stop any background threads and free resources associated with the Engine More...

virtual void	RequestCancel ()
	asyncronous request all jobs to Cancel More...

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 IAppJobEngine
virtual	~IAppJobEngine ()

Protected Member Functions
void	x_WorkOnThread ()
	performs job execution on a separate scheduling thread More...

void	x_RunJob ()

unsigned long	x_GetWaitPeriod ()

Protected Member Functions inherited from CObject
virtual void	DeleteThis (void)
	Virtual method "deleting" this object. More...

Protected Attributes
CMutex	m_Mutex

list< CJobRecord >	m_Jobs

CSemaphore	m_WakeSignal

CAtomicCounter_WithAutoInit	m_StopRequested

IAppJobEngineListener *	m_Listener

CRef< CThread >	m_WorkerThread

Friends
class	CSchedulerEngineThread

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...

Detailed Description

CSchedulerEngine CSchedulerEngine is an engine that can be used with CAppJobDispatcher.

The idea of CSchedulerEngine is to use a single background thread for periodic execution of multiple jobs. This kind of engine is useful for doing quick repetitive tasks such as polling external services every once in while. All jobs share the same thread so they should execute really quick. To be compatible with CSchedulerEngine a job needs to implement IWaitPeriod interface.

Definition at line 60 of file scheduler_engine.hpp.

Member Typedef Documentation

◆ TJobState

typedef IAppJob::EJobState CSchedulerEngine::TJobState

Definition at line 66 of file scheduler_engine.hpp.

Constructor & Destructor Documentation

◆ CSchedulerEngine()

CSchedulerEngine::CSchedulerEngine ( )

CSchedulerEngine.

Definition at line 64 of file scheduler_engine.cpp.

References CSchedulerEngineThread, CThread::fRunNice, m_WorkerThread, CRef< C, Locker >::Reset(), and CThread::Run().

◆ ~CSchedulerEngine()

CSchedulerEngine::~CSchedulerEngine ( )

virtual

Definition at line 72 of file scheduler_engine.cpp.

Member Function Documentation

◆ CancelJob()

void CSchedulerEngine::CancelJob ( IAppJob & job )

virtual

Cancel job in the engine If job is not running yet - just remove from the pending queue otherwise uses IInterruptible to notify the job about cancel request.

Implements IAppJobEngine.

Definition at line 135 of file scheduler_engine.cpp.

References CTime::eCurrent, i, m_Jobs, m_Mutex, m_WakeSignal, CSemaphore::Post(), and IAppJob::RequestCancel().