MeVisLabToolboxReference
ml::BackgroundTaskHandle Class Reference

A handle to a task that has been created by the background task manager. More...

#include <mlBackgroundTaskHandle.h>

Inheritance diagram for ml::BackgroundTaskHandle:
ml::TypedBackgroundTaskHandle< Task >

Public Member Functions

 BackgroundTaskHandle ()
 
void clear ()
 clears the handle, make sure to call this from the taskFinishedCB of the background task manager More...
 
bool hasTask () const
 check if the handle has a task More...
 
bool hasRunningTask () const
 check if the handle has a task which is not canceled More...
 
bool isCanceled () const
 check if the task was canceled More...
 
void cancel ()
 cancel the running task More...
 
void setOwnerWasDeleted ()
 tell the task that the owner was deleted More...
 

Protected Member Functions

 BackgroundTaskHandle (BackgroundTask *task)
 

Protected Attributes

BackgroundTask_task
 

Friends

class BackgroundTaskManager
 
class BackgroundTaskHandleAccessor
 

Detailed Description

A handle to a task that has been created by the background task manager.

This handle allows limited access to a running task, to avoid that users call methods that are not desired to be called during the task is processed in a worker thread.

Definition at line 30 of file mlBackgroundTaskHandle.h.

Constructor & Destructor Documentation

ml::BackgroundTaskHandle::BackgroundTaskHandle ( )
inline

Definition at line 33 of file mlBackgroundTaskHandle.h.

ml::BackgroundTaskHandle::BackgroundTaskHandle ( BackgroundTask task)
inlineprotected

Definition at line 56 of file mlBackgroundTaskHandle.h.

Member Function Documentation

void ml::BackgroundTaskHandle::cancel ( )

cancel the running task

void ml::BackgroundTaskHandle::clear ( )

clears the handle, make sure to call this from the taskFinishedCB of the background task manager

bool ml::BackgroundTaskHandle::hasRunningTask ( ) const

check if the handle has a task which is not canceled

bool ml::BackgroundTaskHandle::hasTask ( ) const

check if the handle has a task

bool ml::BackgroundTaskHandle::isCanceled ( ) const

check if the task was canceled

void ml::BackgroundTaskHandle::setOwnerWasDeleted ( )

tell the task that the owner was deleted

Friends And Related Function Documentation

friend class BackgroundTaskHandleAccessor
friend

Definition at line 55 of file mlBackgroundTaskHandle.h.

friend class BackgroundTaskManager
friend

Definition at line 54 of file mlBackgroundTaskHandle.h.

Member Data Documentation

BackgroundTask* ml::BackgroundTaskHandle::_task
protected

Definition at line 58 of file mlBackgroundTaskHandle.h.


The documentation for this class was generated from the following file: