ldas-tools-al
2.6.3
|
A unit of work to be done usually within a thread. More...
#include <Task.hh>
Classes | |
struct | _p_type |
Public Types | |
typedef boost::shared_ptr< char > | name_type |
typedef Thread::cancel_type | cancel_method |
typedef Thread::signal_type | signal_type |
Data class for passing signal information. More... | |
typedef boost::shared_ptr< char > | name_type |
typedef Thread::cancel_type | cancel_method |
typedef Thread::signal_type | signal_type |
Data class for passing signal information. More... | |
typedef boost::shared_ptr< char > | name_type |
typedef Thread::cancel_type | cancel_method |
typedef Thread::signal_type | signal_type |
Data class for passing signal information. More... | |
Public Member Functions | |
Task (const std::string &Name, cancel_method CancelMethod=Thread::CANCEL_ABANDON, signal_type CancelSignal=SignalHandler::SIGNAL_UNKNOWN) | |
Constructor. More... | |
virtual | ~Task () |
Destructor. More... | |
MutexLock::baton_type | Baton () const |
Retrieve baton to gain exclusive access. More... | |
cancel_method | CancelMethod () const |
Retrieve method to use for terminating the task. More... | |
signal_type | CancelSignal () const |
Retrieve signal to use for terminating the task. More... | |
bool | DeleteOnCompletion () const |
Retrieve state information concearning deletion. More... | |
virtual void | OnCompletion (int TaskThreadState) |
Action to be done when task completes. More... | |
name_type | TaskName () const |
Get the name of the current task. More... | |
virtual void | operator() ()=0 |
Action to perform. More... | |
Task (const std::string &Name, cancel_method CancelMethod=Thread::CANCEL_ABANDON, signal_type CancelSignal=SignalHandler::SIGNAL_UNKNOWN) | |
Constructor. More... | |
virtual | ~Task () |
Destructor. More... | |
MutexLock::baton_type | Baton () const |
Retrieve baton to gain exclusive access. More... | |
cancel_method | CancelMethod () const |
Retrieve method to use for terminating the task. More... | |
signal_type | CancelSignal () const |
Retrieve signal to use for terminating the task. More... | |
bool | DeleteOnCompletion () const |
Retrieve state information concearning deletion. More... | |
virtual void | OnCompletion (int TaskThreadState) |
Action to be done when task completes. More... | |
name_type | TaskName () const |
Get the name of the current task. More... | |
virtual void | operator() ()=0 |
Action to perform. More... | |
Task (const std::string &Name, cancel_method CancelMethod=Thread::CANCEL_ABANDON, signal_type CancelSignal=SignalHandler::SIGNAL_UNKNOWN) | |
Constructor. More... | |
virtual | ~Task () |
Destructor. More... | |
MutexLock::baton_type | Baton () const |
Retrieve baton to gain exclusive access. More... | |
cancel_method | CancelMethod () const |
Retrieve method to use for terminating the task. More... | |
signal_type | CancelSignal () const |
Retrieve signal to use for terminating the task. More... | |
bool | DeleteOnCompletion () const |
Retrieve state information concearning deletion. More... | |
virtual void | OnCompletion (int TaskThreadState) |
Action to be done when task completes. More... | |
name_type | TaskName () const |
Get the name of the current task. More... | |
virtual void | operator() ()=0 |
Action to perform. More... | |
Protected Member Functions | |
void | taskName (const std::string &Name) |
void | delete_on_completion (bool Value) |
void | taskName (const std::string &Name) |
void | delete_on_completion (bool Value) |
void | taskName (const std::string &Name) |
void | delete_on_completion (bool Value) |
Private Attributes | |
name_type | name |
std::unique_ptr< _p_type > | _p |
A unit of work to be done usually within a thread.
This is an abstract class that should be used as the base for a class that is to perform some task usually within a thread.
typedef boost::shared_ptr< char > LDASTools::AL::Task::name_type |
typedef boost::shared_ptr< char > LDASTools::AL::Task::name_type |
typedef boost::shared_ptr< char > LDASTools::AL::Task::name_type |
Data class for passing signal information.
Data class for passing signal information.
Data class for passing signal information.
LDASTools::AL::Task::Task | ( | const std::string & | Name, |
cancel_method | CancelMethod = Thread::CANCEL_ABANDON , |
||
signal_type | CancelSignal = SignalHandler::SIGNAL_UNKNOWN |
||
) |
Constructor.
[in] | Name | Sudo unique name identifying the task |
[in] | CancelMethod | Method to use when terminating the task |
[in] | CancelSignal | Signal to use for termination of the task |
|
virtual |
Destructor.
LDASTools::AL::Task::Task | ( | const std::string & | Name, |
cancel_method | CancelMethod = Thread::CANCEL_ABANDON , |
||
signal_type | CancelSignal = SignalHandler::SIGNAL_UNKNOWN |
||
) |
Constructor.
[in] | Name | Sudo unique name identifying the task |
[in] | CancelMethod | Method to use when terminating the task |
[in] | CancelSignal | Signal to use for termination of the task |
|
virtual |
Destructor.
LDASTools::AL::Task::Task | ( | const std::string & | Name, |
cancel_method | CancelMethod = Thread::CANCEL_ABANDON , |
||
signal_type | CancelSignal = SignalHandler::SIGNAL_UNKNOWN |
||
) |
Constructor.
[in] | Name | Sudo unique name identifying the task |
[in] | CancelMethod | Method to use when terminating the task |
[in] | CancelSignal | Signal to use for termination of the task |
|
virtual |
Destructor.
MutexLock::baton_type LDASTools::AL::Task::Baton | ( | ) | const |
Retrieve baton to gain exclusive access.
MutexLock::baton_type LDASTools::AL::Task::Baton | ( | ) | const |
Retrieve baton to gain exclusive access.
MutexLock::baton_type LDASTools::AL::Task::Baton | ( | ) | const |
Retrieve baton to gain exclusive access.
Task::cancel_method LDASTools::AL::Task::CancelMethod | ( | ) | const |
Retrieve method to use for terminating the task.
cancel_method LDASTools::AL::Task::CancelMethod | ( | ) | const |
Retrieve method to use for terminating the task.
cancel_method LDASTools::AL::Task::CancelMethod | ( | ) | const |
Retrieve method to use for terminating the task.
signal_type LDASTools::AL::Task::CancelSignal | ( | ) | const |
Retrieve signal to use for terminating the task.
Task::signal_type LDASTools::AL::Task::CancelSignal | ( | ) | const |
Retrieve signal to use for terminating the task.
signal_type LDASTools::AL::Task::CancelSignal | ( | ) | const |
Retrieve signal to use for terminating the task.
|
protected |
|
protected |
|
protected |
bool LDASTools::AL::Task::DeleteOnCompletion | ( | ) | const |
Retrieve state information concearning deletion.
bool LDASTools::AL::Task::DeleteOnCompletion | ( | ) | const |
Retrieve state information concearning deletion.
bool LDASTools::AL::Task::DeleteOnCompletion | ( | ) | const |
Retrieve state information concearning deletion.
|
virtual |
Action to be done when task completes.
This function is called regardless of why the task was terminated. It allows for any special cleanup or other action that needs to happen at the end of a task regardless of why the task terminated.
|
virtual |
Action to be done when task completes.
|
virtual |
Action to be done when task completes.
|
pure virtual |
Action to perform.
Implemented in anonymous_namespace{FileType.cc}::timed_filetype, LDASTools::AL::Timer, LDASTools::AL::Timer, LDASTools::AL::Timer, LDASTools::AL::SystemCallTask, LDASTools::AL::SystemCallTask, and LDASTools::AL::SystemCallTask.
|
pure virtual |
Action to perform.
Implemented in anonymous_namespace{FileType.cc}::timed_filetype, LDASTools::AL::Timer, LDASTools::AL::Timer, LDASTools::AL::Timer, LDASTools::AL::SystemCallTask, LDASTools::AL::SystemCallTask, and LDASTools::AL::SystemCallTask.
|
pure virtual |
Action to perform.
Implemented in anonymous_namespace{FileType.cc}::timed_filetype, LDASTools::AL::Timer, LDASTools::AL::Timer, LDASTools::AL::Timer, LDASTools::AL::SystemCallTask, LDASTools::AL::SystemCallTask, and LDASTools::AL::SystemCallTask.
name_type LDASTools::AL::Task::TaskName | ( | ) | const |
Get the name of the current task.
|
inline |
Get the name of the current task.
name_type LDASTools::AL::Task::TaskName | ( | ) | const |
Get the name of the current task.
|
protected |
|
inlineprotected |
|
protected |
|
private |
|
private |