This is the documentation for Enlighten.

class Enlighten IAsyncTask

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

Name Description
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.


void Enlighten::IAsyncTask::DoWork


public: void DoWork()


Callback function which is called to execute the asynchronous task.


void Enlighten::IAsyncTask::Reset


public: void Reset()


Reset the task event.


void Enlighten::IAsyncTask::SetTaskProcessor


public: void SetTaskProcessor
(
    TaskProcessor * taskProcessor
)


Set the task processor object.


void Enlighten::IAsyncTask::Wait


public: void Wait()


Wait on the task event.