Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/classCAppJobTask.html below:
NCBI C++ ToolKit: CAppJobTask Class Reference
CAppJobTask (bool visible, const string &descr=kEmptyStr, int prog_rep_period=5, const string &engine_name="ThreadPool", int display_delay=0) CAppJobTask (IAppJob &job, bool visible, const string &descr=kEmptyStr, int prog_rep_period=5, const string &engine_name="ThreadPool", int display_delay=0) virtual ~CAppJobTask () void SetReportErrors (bool report) enabled / disbale error reporting for failed Jobs More...
CIRef< IAppJob > GetJob () void OnAppJobNotification (CEvent *event) functions below handle notifications from the IAppJob More...
void OnAppJobProgress (CEvent *event) void OnAppJobDataReady (CEvent *event) virtual ETaskState Run () execute the task, this function is called on the main UI thread if a task needs to execute in background it should launch a job that will execute asynchronously; then the function shall return eBackgrounded More...
virtual void CancelBackgrounded () make a request to cancel backgrounded task (not called for foreground tasks) More...
virtual string GetStatusText () const returns human-readable text describing the current task state More...
CAppTask (const string &descr=kEmptyStr, bool visible=true, int display_delay=0) CAppTask. More...
virtual ETaskState GetState () returns the current task state More...
virtual void OnCancel () this will be called on pending tasks that will be removed from the queue and won't get a chance to run the purpose is to implement any cleanup procedures for the canceled task More...
virtual bool IsVisible () returns true if the task should be visible in UI visible task shall represent operations understood by users and usually correspond to menu commands. More...
int GetStatusDisplayDelay () returns delay in seconds used for certain fast (and not very important tasks) to only show its status when it is running/pending for long enough More...
virtual string GetDescr () const returns a human-readable description of the Task (optional) More...
virtual void SetListener (CEventHandler *handler) set a Listener; this allows a taks running in background to notify the Listener (usually Task Manager) about changes in Status More...
virtual IEventLogAction * CreateEventLogAction () returns an action for activating task results (optional, can return NULL) More...
CObjectEx (void) virtual ~CObjectEx (void) 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...
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 CWeakObject (void) virtual ~CWeakObject (void) CPtrToObjectProxy * GetPtrProxy (void) const Get pointer to proxy object containing pointer to this object. More...
virtual ~IAppTask () Public Member Functions inherited from CEventHandler CEventHandler () CEventHandler. More...
virtual ~CEventHandler () virtual void AddListener (CEventHandler *listener, int pool_name=ePool_Default) Add a listener. More...
virtual void RemoveListener (CEventHandler *listener) Remove a listener. More...
virtual void RemoveAllListeners (void) virtual bool HasListener (CEventHandler *listener, int pool_name=ePool_Default) const returns "true" if the given listener belongs to the specified pool More...
virtual const TListeners * GetListeners (int pool_name=ePool_Default) const returns a set of listeners fro the specified pool More...
virtual bool OnEvent (CEvent *evt) Processes en event. Returns "true" if event has been processed. More...
virtual bool Dispatch (CEvent *evt, EDispatch disp_how=eDispatch_Default, int pool_name=ePool_Default) Dispatches an event to the listeners (but does not handle it). More...
virtual bool Send (CEvent *evt, EDispatch disp_how=eDispatch_Default, int pool_name=ePool_Default) Sends an event synchronously. More...
virtual bool Send (CEvent *evt, int pool_name) void Post (CRef< CEvent > evt, EDispatch disp_how=eDispatch_Default, int pool_name=ePool_Default) Handles an event asynchronously (process and/or dispatch). More...
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...
enum ETaskState {
eInvalid = -1 , eInitial , eRunning , eBackgrounded ,
eCompleted , eFailed , eCanceled , eLastState
} List of task states defining the task management FSM. More...
Public Types inherited from CEventHandler enum EDispatch { eDispatch_SelfOnly , eDispatch_AllHandlers , eDispatch_FirstHandler , eDispatch_Default = eDispatch_AllHandlers } enum controlling dispatching strategies More...
enum EPoolName {
ePool_Default = 0 , ePool_Parent , ePool_Child , ePool_Sibling ,
ePool_NextAvailable
} Identifiers for standard pools. More...
typedef vector< CEventHandler * > TListeners typedef map< int, TListeners > TPools typedef list< AutoPtr< SPostRequest > > TPostRequests typedef std::map< CEventHandler *, int > THandlerToCount typedef void(* FOnPostCallback) () static string StateToString (ETaskState state) 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 void EnableDebugDump (bool on) Static Public Member Functions inherited from CEventHandler static bool HandlePostRequest () static void ClearPostQueue () erases all events from the queue More...
static void DestroyPostQueue () 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...
Static Protected Attributes inherited from CEventHandler static const SEvtMap sm_EvtMap
CAppJobTask CAppJobTask is an adapter that allows for running IAppJobs as Tasks in App Task Service.
CAppJobTask is a wrapper around IAppJob that implements IAppTask interface and so can be used with CAppTaskService. When launched by Task Service CAppJobTask starts the given Job and then returns with eBackgrounded status. When the job finishes CAppJobTask notifies Task Service so that it could resume executing the Task. This class is NOT thread-safe and is designed to be used on the main UI thread only (what is consistent with Task Manager design).
Definition at line 66 of file app_job_task.hpp.
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4