Home Reference Source 
import {Task} from 'rabbit-hole'
public class | source

Task

Implements:

A worker task.

Constructor Summary

Public Constructor
public

Constructs a new task.

Member Summary

Public Members
public

The primary octant that is involved in this task.
public

The LOD value and the key of the primary octant.
public

request: Request

A worker request.
public

A list of secondary octant IDs.
public

secondaryOctants: WorlcOctant[]

A list of secondary octants that are involved in this task.

Method Summary

Public Methods
public

createRequest(): Request

Prepares a request that can be sent to a worker thread.
public

createTransferList(transferList: Array): Transferable[]

Creates a list of transferable items.
public

reclaimData(response: Response)

Reclaims ownership of volume data to complete the round trip.

Public Constructors

public constructor() source

Constructs a new task.

Public Members

public octant: WorldOctant source

The primary octant that is involved in this task.

public octantId: WorldOctantId source

The LOD value and the key of the primary octant.

public request: Request source

A worker request.

public secondaryOctantIds: WorldOctantId[] source

A list of secondary octant IDs.

public secondaryOctants: WorlcOctant[] source

A list of secondary octants that are involved in this task.

Public Methods

public createRequest(): Request source

Prepares a request that can be sent to a worker thread.

Return:

Request

The request.

public createTransferList(transferList: Array): Transferable[] source

Creates a list of transferable items.

Params:

NameTypeAttributeDescription
transferList Array
  • optional

An optional target list. The transferable items will be added to this list.

Return:

Transferable[]

The transfer list.

public reclaimData(response: Response) source

Reclaims ownership of volume data to complete the round trip.

Params:

NameTypeAttributeDescription
response Response

A worker response.