Search Toolkit Book for CAppTaskService
CAppTaskService - Application Task Service. More...
#include <gui/framework/app_task_service.hpp>
Inheritance diagram for CAppTaskService:
Collaboration diagram for CAppTaskService:
Classes | |
| class | CTaskRecord |
Public Types | |
| enum | EConsts { eInvalidTaskID = -1 } |
| typedef IAppTask::ETaskState | TTaskState |
| typedef CIRef< IAppTask > | TTaskRef |
| typedef vector< TTaskRef > | TTaskRefVec |
| typedef CRef< CTaskRecord > | TRecordRef |
| typedef vector< TRecordRef > | TRecRefVec |
| 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 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) () |
Public Member Functions | |
| CAppTaskService () | |
| virtual | ~CAppTaskService () |
| void | AddTask (IAppTask &task) |
| Add a task to the queue. More... | |
| bool | CancelTask (IAppTask &task, bool throw_on_error=true) |
| Places a request to cancel a backgrounded task. More... | |
| bool | IdleCallback () |
| This function shall be called in the the application idle function, it polls the Task Queue and executes pending tasks. More... | |
| void | GetPendingTasks (TRecRefVec &tasks) |
| Inspection interface - supposed to be used from the main UI thread only. More... | |
| void | GetBackgroundedTasks (TRecRefVec &tasks) |
| int | GetRunningTasksCount (bool vis_only=true) |
| returns the number of running and backgrounded tasks More... | |
IService implementation | |
| virtual void | InitService () |
| virtual void | ShutDownService () |
| Cancels all backgrounded tasks, removes pending tasks and blocks processing of incoming requests and events. More... | |
| void | PreShutDownService () |
IServiceLocatorConsumer interface implementation | |
| virtual void | SetServiceLocator (IServiceLocator *srv_locator) |
| Public Member Functions inherited from CObjectEx | |
| CObjectEx (void) | |
| virtual | ~CObjectEx (void) |
| 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 CWeakObject | |
| CWeakObject (void) | |
| virtual | ~CWeakObject (void) |
| CPtrToObjectProxy * | GetPtrProxy (void) const |
| Get pointer to proxy object containing pointer to this object. More... | |
| 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... | |
| Public Member Functions inherited from IService | |
| virtual | ~IService () |
| Public Member Functions inherited from IServiceLocatorConsumer | |
| virtual | ~IServiceLocatorConsumer () |
Protected Types | |
| typedef CSyncQueue< TRecordRef > | TQueue |
| typedef map< TTaskRef, TRecordRef > | TRecordMap |
Protected Member Functions | |
| void | x_OnWakeUpSignal (CEvent *event) |
| void | x_OnTaskCanceled (CEvent *event) |
| void | x_OnStatusUpdate (CEvent *event) |
| void | x_ExecuteNextTaskInQueue () |
| void | x_LogTask (IEventRecord::EType type, const string &prefix, IAppTask &task, const string &postfix, const string &details=kEmptyStr) |
| void | x_ReportTaskFailure (IAppTask &task, const string &err_msg, const string &details) |
| Protected Member Functions inherited from CObject | |
| virtual void | DeleteThis (void) |
| Virtual method "deleting" this object. More... | |
| Protected Member Functions inherited from CWeakObject | |
| void | CleanWeakRefs (void) const |
| Method cleaning all CWeakRefs referencing at this moment to the object After calling to this method all existing CWeakRefs referencing to the object will return NULL, so it effectively will be equal to deleting the object. More... | |
| Protected Member Functions inherited from CEventHandler | |
| virtual const SEvtMap * | GetEventMap () const |
| void | x_DeclareDead () |
| Removes itself unavailable for async event delivery. More... | |
| void | x_AddListenerToPool (CEventHandler *listener, int pool_name) |
Protected Attributes | |
| CMutex | m_Mutex |
| IServiceLocator * | m_ServiceLocator |
| IEventLogService * | m_EventLogService |
| bool | m_ShutDown |
| TQueue | m_PendingTasks |
| TRecordMap | m_BackgoundedTasks |
| IAppTask * | m_RunningTask |
| Protected Attributes inherited from CEventHandler | |
| TPools | m_Pools |
Private Member Functions | |
| DECLARE_EVENT_MAP () | |
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 Member Functions inherited from CEventHandler | |
| static bool | HandlePostRequest () |
| static void | ClearPostQueue () |
| erases all events from the queue More... | |
| static void | DestroyPostQueue () |
| 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... | |
| Static Protected Attributes inherited from CEventHandler | |
| static const SEvtMap | sm_EvtMap |
Detailed Description
CAppTaskService - Application Task Service.
Definition at line 69 of file app_task_service.hpp.
The documentation for this class was generated from the following files:
- include/gui/framework/app_task_service.hpp
- src/gui/framework/app_task_service.cpp
