NCBI C++ ToolKit
Public Types | Public Member Functions | List of all members
IAppJobEngine Class Referenceabstract

Search Toolkit Book for IAppJobEngine

IAppJobEngine. More...

#include <gui/utils/app_job_engine.hpp>

+ Inheritance diagram for IAppJobEngine:

Public Types

typedef CAppJobDispatcher TDisp
 
typedef IAppJob::EJobState TJobState
 

Public Member Functions

virtual ~IAppJobEngine ()
 
virtual bool IsActive ()=0
 Returns true if Engine supports "active" model i.e. More...
 
virtual void SetListener (IAppJobEngineListener *listener)=0
 For "active" mode set a Listener that will be notified when the state of a Job changes. More...
 
virtual void StartJob (IAppJob &job, IEngineParams *params=NULL)=0
 If Engine cannot start the Job and exception shall be thrown. More...
 
virtual void CancelJob (IAppJob &job)=0
 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 &job)=0
 
virtual void ResumeJob (IAppJob &job)=0
 
virtual TJobState GetJobState (IAppJob &job) const =0
 
virtual void ShutDown ()=0
 stop any background threads and free resources associated with the Engine More...
 
virtual void RequestCancel ()=0
 asyncronous request all jobs to Cancel More...
 

Detailed Description

IAppJobEngine.

Base interface for building engines for background job execution

See also
IAppJob

Definition at line 55 of file app_job_engine.hpp.


The documentation for this class was generated from the following file:
Modified on Fri Apr 12 17:20:08 2024 by modify_doxy.py rev. 669887