Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

class Enlighten::IAsyncTask

Async task interface.

Class for tasks that the HLRT executes via an async work callback. This is included for backwards compatibility, and has been superseded by IThreadGroup. Since there is now only one type of task it is a concrete class, but retains the name IAsyncTask for historical reasons.

Functions

NameDescription
DoWork()

Callback function which is called to execute the asynchronous task.

Reset()

Reset the task event.

SetTaskProcessor(TaskProcessor *)

Set the task processor object.

Wait()

Wait on the task event.


Anchor
aa892d04dc85468d8f894b3c8ba896bbe
aa892d04dc85468d8f894b3c8ba896bbe

void Enlighten::IAsyncTask::DoWork

...

public: void DoWork()

...

Callback function which is called to execute the asynchronous task.


Anchor
af948d447c0d968f10975e4681e883d93
af948d447c0d968f10975e4681e883d93

void Enlighten::IAsyncTask::Reset

...

public: void Reset()

...

Reset the task event.


Anchor
a5f8d85916e418a982285f7e289b9b8b5
a5f8d85916e418a982285f7e289b9b8b5

void Enlighten::IAsyncTask::SetTaskProcessor

...

public: void SetTaskProcessor
(
    TaskProcessor * taskProcessor
)

...

Set the task processor object.


Anchor
a4fc1e32f883d5f0bf805539528af4bfe
a4fc1e32f883d5f0bf805539528af4bfe

void Enlighten::IAsyncTask::Wait

...

public: void Wait()

...

Wait on the task event.