Class: Task
yajsapi / Exports / executor/task / Task
executor/task.Task
One computation unit.
description Represents one computation unit that will be run on the provider (e.g. rendering of one frame of an animation).
Name |
|
|
counter
• new Task(data)
Create a new Task object.
Type parameters
Name |
|
|
Parameters
Name | Type | Description |
|
| contains information needed to prepare command list for the provider |
Defined in
• Private _callbacks: Set<null | Function>
Defined in
• Private _data: any
Defined in
• Private _emit_event: any
Defined in
• Private _finished: null | number
Defined in
• Private Optional _handle: [Handle<Task>, SmartQueue<Task>]
Defined in
• Private Optional _result: null | TaskResult
Defined in
• Private _started: null | number
Defined in
• Private _status: TaskStatus
Defined in
• id: number = 0
Defined in
▪ Static count: number = 0
Defined in
• Static get counter(): number
Returns
number
Defined in
yajsapi/executor/task.ts:150
▸ _add_callback(callback): void
Parameters
Name | Type |
|
|
Returns
void
Defined in
▸ _start(_emitter): void
Parameters
Name | Type |
|
|
Returns
void
Defined in
▸ _stop(retry?): void
Parameters
Name | Type | Default value |
|
| false |
Returns
void
Defined in
▸ accept_result(result?): void
Accept the result of this task.
description Must be called when the result is correct to mark this task as completed.
Parameters
Name | Type | Default value | Description |
|
| null | task computation result (optional) |
Returns
void
Defined in
yajsapi/executor/task.ts:120
▸ data(): TaskData
Returns
TaskData
Defined in
▸ reject_result(reason?, retry?): void
Reject the result of this task.
description Must be called when the result is not correct to indicate that the task should be retried.
Parameters
Name | Type | Default value | Description |
|
| null | Task rejection description (optional) |
|
| false | Task retry in case of rejects (optional) |
Returns
void
Defined in
yajsapi/executor/task.ts:139
▸ result(): undefined | null | TaskResult
Returns
undefined | null | TaskResult
Defined in
▸ running_time(): null | number
Returns
null | number
Defined in
yajsapi/executor/task.ts:103
▸ status(): TaskStatus
Returns
Defined in
▸ Static for_handle(handle, queue, emitter): Task<"TaskData", "TaskResult">
Parameters
Returns
Task<"TaskData", "TaskResult">
Defined in
