NCBI C++ ToolKit
Public Member Functions | Protected Attributes | List of all members
CPeriodicTestJob Class Reference

Search Toolkit Book for CPeriodicTestJob

CPrimeNumbersJob. More...

#include "test_client.hpp"
(Private to src/gui/utils/app_job.)

+ Inheritance diagram for CPeriodicTestJob:
+ Collaboration diagram for CPeriodicTestJob:

Public Member Functions

 CPeriodicTestJob (int period_sec)
 
IAppJob implementation
virtual IAppJob::EJobState Run ()
 Function that does all the useful work, called by the Engine. More...
 
virtual void RequestCancel ()
 RequestCancel() is called to notify the Job that it shall exit Run() function ASAP. More...
 
virtual bool IsCanceled () const
 
virtual CConstIRef< IAppJobProgressGetProgress ()
 return progress object, the function shall be synchronized internally. More...
 
virtual CRef< CObjectGetResult ()
 Returns the Job Result. More...
 
virtual CConstIRef< IAppJobErrorGetError ()
 Returns IAppJobError object describing internal error that caused the Job to fail. More...
 
virtual string GetDescr () const
 Returns a human readable description of the Job (optional) More...
 
virtual CTimeSpan GetWaitPeriod ()
 IWaitPeriod additional functions 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
 
- 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...
 
- Public Member Functions inherited from IWaitPeriod
virtual ~IWaitPeriod ()
 

Protected Attributes

CTimeSpan m_Period
 
bool m_StopRequested
 
bool m_Finished
 
CConstIRef< IAppJobProgressm_Progress
 
CConstIRef< IAppJobErrorm_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 CAtomicCounter TCounter
 Counter type is CAtomiCounter. More...
 
typedef TCounter::TValue 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_NORETURN void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_NORETURN 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

CPrimeNumbersJob.

Definition at line 80 of file test_client.hpp.

Constructor & Destructor Documentation

CPeriodicTestJob::CPeriodicTestJob ( int  period_sec)

Definition at line 137 of file test_client.cpp.

References m_Error, m_Progress, and CConstRef< C, Locker >::Reset().

Member Function Documentation

string CPeriodicTestJob::GetDescr ( ) const
virtual

Returns a human readable description of the Job (optional)

Implements IAppJob.

Definition at line 202 of file test_client.cpp.

Referenced by CPrimeNumberClient::StartJobs().

CConstIRef< IAppJobError > CPeriodicTestJob::GetError ( )
virtual

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 196 of file test_client.cpp.

References m_Error.

CConstIRef< IAppJobProgress > CPeriodicTestJob::GetProgress ( )
virtual

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 183 of file test_client.cpp.

References m_Progress.

CRef< CObject > CPeriodicTestJob::GetResult ( )
virtual

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 189 of file test_client.cpp.

CTimeSpan CPeriodicTestJob::GetWaitPeriod ( )
virtual

IWaitPeriod additional functions

Implements IWaitPeriod.

Definition at line 209 of file test_client.cpp.

References m_Period.

bool CPeriodicTestJob::IsCanceled ( void  ) const
virtual

Implements IAppJob.

Definition at line 177 of file test_client.cpp.

References m_StopRequested.

void CPeriodicTestJob::RequestCancel ( )
virtual

RequestCancel() is called to notify the Job that it shall exit Run() function ASAP.

The function shall be synchronized internally.

Implements IAppJob.

Definition at line 172 of file test_client.cpp.

References m_StopRequested.

IAppJob::EJobState CPeriodicTestJob::Run ( )
virtual

Function that does all the useful work, called by the Engine.

Run() shall be implemented so that it will allow for exiting once RequestCancel() is called.

Implements IAppJob.

Definition at line 147 of file test_client.cpp.

References CTime::AsString(), CTimeSpan::AsString(), IAppJob::eCanceled, IAppJob::eCompleted, ePositive, IAppJob::eRunning, CTimeSpan::GetSign(), kDecrement, kSleepTime_ms, LOG_POST, m_Period, m_StopRequested, CTime::SetCurrent(), and SleepMilliSec().

Member Data Documentation

CConstIRef<IAppJobError> CPeriodicTestJob::m_Error
protected

Definition at line 110 of file test_client.hpp.

Referenced by CPeriodicTestJob(), and GetError().

bool CPeriodicTestJob::m_Finished
protected

Definition at line 107 of file test_client.hpp.

CTimeSpan CPeriodicTestJob::m_Period
protected

Definition at line 105 of file test_client.hpp.

Referenced by GetWaitPeriod(), and Run().

CConstIRef<IAppJobProgress> CPeriodicTestJob::m_Progress
protected

Definition at line 109 of file test_client.hpp.

Referenced by CPeriodicTestJob(), and GetProgress().

bool CPeriodicTestJob::m_StopRequested
protected

Definition at line 106 of file test_client.hpp.

Referenced by IsCanceled(), RequestCancel(), and Run().


The documentation for this class was generated from the following files:
Modified on Wed Aug 16 05:56:19 2017 by modify_doxy.py rev. 533848