Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

at::Task Class Reference

#include <at_thread.h>

Inheritance diagram for at::Task:

Inheritance graph
[legend]
Collaboration diagram for at::Task:

Collaboration graph
[legend]
List of all members.

Public Types

typedef SYS_TaskID TaskID

Public Methods

 Task ()
virtual ~Task ()
virtual void Work ()=0 throw ()
void Start ()
void Wait ()
void Wait (const TimeInterval &i_time)
TaskID GetThisId ()

Static Public Methods

TaskID GetSelfId ()

Friends

struct TaskContext

Detailed Description

Task is the base "task" class that implements the threading interface for Austria threads. The application is required to implement the "Work" method. Once the class has been created the "Start" method may be called to commence the new thread. The thread


Member Typedef Documentation

typedef SYS_TaskID at::Task::TaskID
 

TaskID is system specific. The only operations that will be supported across all platforms are ostream << TaskID, equality and less than.


Constructor & Destructor Documentation

at::Task::Task  
 

Task constructor.

at::Task::~Task   [virtual]
 

The Task destructor will implicitly wait for the thread to terminate.


Member Function Documentation

Task::TaskID at::Task::GetSelfId   [static]
 

Get the thread ID of the calling thread.

Returns:
nothing

Task::TaskID at::Task::GetThisId  
 

Get the thread ID of the this thread.

Returns:
The thread ID of this thread.

void at::Task::Start  
 

Start will initiate the created thread. Start must be called exactly once.

Returns:
nothing

void at::Task::Wait const TimeInterval   i_time
 

Wait will wait for the termination of this thread. (also called join). This version of wail will not wait more than i_time.

Parameters:
i_time  The maximum time to wait.
Returns:
nothing

void at::Task::Wait  
 

Wait will wait for the termination of this thread. (also called join).

Returns:
nothing

virtual void at::Task::Work   throw () [pure virtual]
 

Work is derived by the application to perform the work required by the task.

Returns:
nothing

Implemented in Task_Test.


Friends And Related Function Documentation

friend struct TaskContext [friend]
 


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

Generated for Austria by doxygen and MakeXS at Sun Oct 24 17:35:34 PDT 2004