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 |
|
|
Task
counter
new Task(data
: TaskData): Task
Create a new Task object.
Type parameters:
Name |
|
|
Parameters:
Name | Type | Description |
| TaskData | contains information needed to prepare command list for the provider |
Returns: Task
Defined in: yajsapi/executor/task.ts:38
• Private
_callbacks: Set<null | Function>
Defined in: yajsapi/executor/task.ts:31
• Private
_data: any
Defined in: yajsapi/executor/task.ts:37
• Private
_emit_event: any
Defined in: yajsapi/executor/task.ts:30
• Private
_finished: null | number
Defined in: yajsapi/executor/task.ts:29
• Private
Optional
_handle: undefined | [Handle<Task>, SmartQueue<Task>]
Defined in: yajsapi/executor/task.ts:32
• Private
Optional
_result: undefined | null | TaskResult
Defined in: yajsapi/executor/task.ts:36
• Private
_started: null | number
Defined in: yajsapi/executor/task.ts:28
• Private
_status: TaskStatus
Defined in: yajsapi/executor/task.ts:38
• id: number= 0
Defined in: yajsapi/executor/task.ts:27
▪ Static
count: number= 0
Defined in: yajsapi/executor/task.ts:26
• Static
counter(): number
Returns: number
Defined in: yajsapi/executor/task.ts:150
▸ _add_callback(callback
: Function): void
Parameters:
Name | Type |
| Function |
Returns: void
Defined in: yajsapi/executor/task.ts:59
▸ _start(_emitter
: any): void
Parameters:
Name | Type |
| any |
Returns: void
Defined in: yajsapi/executor/task.ts:63
▸ _stop(retry?
: boolean): void
Parameters:
Name | Type | Default value |
| boolean | false |
Returns: void
Defined in: yajsapi/executor/task.ts:70
▸ accept_result(result?
: null | TaskResult): 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 | TaskResult | null | task computation result (optional) |
Returns: void
Defined in: yajsapi/executor/task.ts:120
▸ data(): TaskData
Returns: TaskData
Defined in: yajsapi/executor/task.ts:95
▸ reject_result(reason?
: null | string, retry?
: boolean): 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 | string | null | Task rejection description (optional) |
| boolean | 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: yajsapi/executor/task.ts:99
▸ running_time(): null | number
Returns: null | number
Defined in: yajsapi/executor/task.ts:103
▸ status(): TaskStatus
Returns: TaskStatus
Defined in: yajsapi/executor/task.ts:91
▸ Static
for_handle(handle
: Handle<Task<any, any>>, queue
: SmartQueue<Task<any, any>>, emitter
: default<[YaEvent], void>): Task<TaskData, TaskResult>
Parameters:
Returns: Task<TaskData, TaskResult>
Defined in: yajsapi/executor/task.ts:80