org.cesiumjs.cs.core

Class TaskProcessor

java.lang.Object

org.cesiumjs.cs.core.TaskProcessor

@JsType(isNative=true,
        namespace="Cesium",
        name="TaskProcessor")
public class TaskProcessor
extends Object

A wrapper around a web worker that allows scheduling tasks for a given worker, returning results asynchronously via a promise. The Worker is not constructed until a task is scheduled.

Author:

Serge Silaev aka iSergio

Constructor Summary

Constructors

Constructor and Description
TaskProcessor(String workerName) A wrapper around a web worker that allows scheduling tasks for a given worker, returning results asynchronously via a promise.
TaskProcessor(String workerName, int maximumActiveTasks) A wrapper around a web worker that allows scheduling tasks for a given worker, returning results asynchronously via a promise.

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroys this object.
Promise<Object,Void>	initWebAssemblyModule() Posts a message to a web worker with configuration to initialize loading and compiling a web assembly module asychronously, as well as an optional fallback JavaScript module to use if Web Assembly is not supported.
Promise<Object,Void>	initWebAssemblyModule(WebAssemblyOptions options) Posts a message to a web worker with configuration to initialize loading and compiling a web assembly module asychronously, as well as an optional fallback JavaScript module to use if Web Assembly is not supported.
boolean	isDestroyed() Returns true if this object was destroyed; otherwise, false.
Promise<Object,Void>	scheduleTask(JsObject parameters) Schedule a task to be processed by the web worker asynchronously.
Promise<Object,Void>	scheduleTask(JsObject parameters, Object[] transferableObjects) Schedule a task to be processed by the web worker asynchronously.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskProcessor

@JsConstructor
public TaskProcessor(String workerName)

A wrapper around a web worker that allows scheduling tasks for a given worker, returning results asynchronously via a promise. The Worker is not constructed until a task is scheduled.

Parameters:

workerName - The name of the worker. This is expected to be a script in the Workers folder.

TaskProcessor

@JsConstructor
public TaskProcessor(String workerName,
                                    int maximumActiveTasks)

A wrapper around a web worker that allows scheduling tasks for a given worker, returning results asynchronously via a promise. The Worker is not constructed until a task is scheduled.

Parameters:

workerName - The name of the worker. This is expected to be a script in the Workers folder.

maximumActiveTasks - The maximum number of active tasks. Once exceeded, scheduleTask will not queue any more tasks, allowing work to be rescheduled in future frames.

Method Detail

destroy

@JsMethod
public void destroy()

Destroys this object. This will immediately terminate the Worker. Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.

initWebAssemblyModule

@JsMethod
public Promise<Object,Void> initWebAssemblyModule()

Posts a message to a web worker with configuration to initialize loading and compiling a web assembly module asychronously, as well as an optional fallback JavaScript module to use if Web Assembly is not supported.

Returns:

A promise that resolves to the result when the web worker has loaded and compiled the web assembly module and is ready to process tasks.

initWebAssemblyModule

@JsMethod
public Promise<Object,Void> initWebAssemblyModule(WebAssemblyOptions options)

Posts a message to a web worker with configuration to initialize loading and compiling a web assembly module asychronously, as well as an optional fallback JavaScript module to use if Web Assembly is not supported.

Parameters:

options - WebAssemblyOptions object.

Returns:

A promise that resolves to the result when the web worker has loaded and compiled the web assembly module and is ready to process tasks.

isDestroyed

@JsMethod
public boolean isDestroyed()

Returns true if this object was destroyed; otherwise, false. If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.

Returns:

True if this object was destroyed; otherwise, false.

See Also:

destroy()

scheduleTask

@JsMethod
public Promise<Object,Void> scheduleTask(JsObject parameters)

Schedule a task to be processed by the web worker asynchronously. If there are currently more tasks active than the maximum set by the constructor, will immediately return undefined. Otherwise, returns a promise that will resolve to the result posted back by the worker when finished.

Parameters:

parameters - Any input data that will be posted to the worker.

Returns:

Either a promise that will resolve to the result when available, or undefined if there are too many active tasks,

scheduleTask

@JsMethod
public Promise<Object,Void> scheduleTask(JsObject parameters,
                                                   Object[] transferableObjects)

Schedule a task to be processed by the web worker asynchronously. If there are currently more tasks active than the maximum set by the constructor, will immediately return undefined. Otherwise, returns a promise that will resolve to the result posted back by the worker when finished.

Parameters:

parameters - Any input data that will be posted to the worker.

transferableObjects - An array of objects contained in parameters that should be transferred to the worker instead of copied.

Returns:

Either a promise that will resolve to the result when available, or undefined if there are too many active tasks,