akasha

Class Worker

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.Worker

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="Worker")
public class Worker
extends EventTarget

The Worker interface of the Web Workers API represents a background task that can be created via script, which can send messages back to its creator.

See Also:

Worker - MDN, (HTML) # dedicated-workers-and-the-worker-interface

Field Summary

Fields

Modifier and Type	Field and Description
EventHandler	onerror The AbstractWorker.onerror property of the AbstractWorker interface represents an EventHandler, that is a function to be called when the error event occurs and bubbles through the Worker.
MessageEventHandler	onmessage The onmessage property of the Worker interface represents an EventHandler, that is a function to be called when the message event occurs.
MessageEventHandler	onmessageerror The onmessageerror event handler of the Worker interface is an EventListener, called whenever an MessageEvent of type messageerror is fired on the Worker instance — that is, when it receives a message that cannot be deserialized.

Constructor Summary

Constructors

Constructor and Description
Worker(java.lang.String scriptURL) The Worker() constructor creates a Worker object that executes the script at the specified URL.
Worker(java.lang.String scriptURL, WorkerOptions options) The Worker() constructor creates a Worker object that executes the script at the specified URL.

Method Summary

Modifier and Type	Method and Description
void	addMessageerrorListener(MessageEventListener callback)
void	addMessageerrorListener(MessageEventListener callback, AddEventListenerOptions options)
void	addMessageerrorListener(MessageEventListener callback, boolean useCapture)
void	addMessageListener(MessageEventListener callback)
void	addMessageListener(MessageEventListener callback, AddEventListenerOptions options)
void	addMessageListener(MessageEventListener callback, boolean useCapture)
void	postMessage(java.lang.Object message) The postMessage() method of the Worker interface sends a message to the worker's inner scope.
void	postMessage(java.lang.Object message, JsArray<Transferable> transfer) The postMessage() method of the Worker interface sends a message to the worker's inner scope.
void	postMessage(java.lang.Object message, PostMessageOptions options) The postMessage() method of the Worker interface sends a message to the worker's inner scope.
void	postMessage(java.lang.Object message, Transferable[] transfer) The postMessage() method of the Worker interface sends a message to the worker's inner scope.
void	removeMessageerrorListener(MessageEventListener callback)
void	removeMessageerrorListener(MessageEventListener callback, boolean useCapture)
void	removeMessageerrorListener(MessageEventListener callback, EventListenerOptions options)
void	removeMessageListener(MessageEventListener callback)
void	removeMessageListener(MessageEventListener callback, boolean useCapture)
void	removeMessageListener(MessageEventListener callback, EventListenerOptions options)
void	terminate() The terminate() method of the Worker interface immediately terminates the Worker.

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

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

Field Detail

onerror

@Nullable
public EventHandler onerror

The AbstractWorker.onerror property of the AbstractWorker interface represents an EventHandler, that is a function to be called when the error event occurs and bubbles through the Worker.

See Also:

Worker.onerror - MDN, AbstractWorker.onerror - HTML Living Standard

onmessage

@Nullable
public MessageEventHandler onmessage

The onmessage property of the Worker interface represents an EventHandler, that is a function to be called when the message event occurs. These events are of type MessageEvent and will be called when the worker's parent receives a message (i.e. from the DedicatedWorkerGlobalScope.postMessage method).

See Also:

Worker.onmessage - MDN, Worker.onmessage - HTML Living Standard

onmessageerror

@Nullable
public MessageEventHandler onmessageerror

The onmessageerror event handler of the Worker interface is an EventListener, called whenever an MessageEvent of type messageerror is fired on the Worker instance — that is, when it receives a message that cannot be deserialized.

See Also:

Worker.onmessageerror - MDN, onmessageerror - HTML Living Standard

Constructor Detail

Worker

public Worker(@Nonnull
              java.lang.String scriptURL,
              @Nonnull
              WorkerOptions options)

The Worker() constructor creates a Worker object that executes the script at the specified URL. This script must obey the same-origin policy.

See Also:

Worker.Worker - MDN, Worker() - HTML Living Standard

Worker

public Worker(@Nonnull
              java.lang.String scriptURL)

The Worker() constructor creates a Worker object that executes the script at the specified URL. This script must obey the same-origin policy.

See Also:

Worker.Worker - MDN, Worker() - HTML Living Standard

Method Detail

postMessage

public void postMessage(@Nullable
                        java.lang.Object message,
                        @Nonnull
                        JsArray<Transferable> transfer)

The postMessage() method of the Worker interface sends a message to the worker's inner scope. This accepts a single parameter, which is the data to send to the worker. The data may be any value or JavaScript object handled by the structured clone algorithm, which includes cyclical references.

See Also:

Worker.postMessage - MDN, Worker.postMessage() - HTML Living Standard

postMessage

public void postMessage(@Nullable
                        java.lang.Object message,
                        @Nonnull
                        Transferable[] transfer)

The postMessage() method of the Worker interface sends a message to the worker's inner scope. This accepts a single parameter, which is the data to send to the worker. The data may be any value or JavaScript object handled by the structured clone algorithm, which includes cyclical references.

See Also:

Worker.postMessage - MDN, Worker.postMessage() - HTML Living Standard

postMessage

public void postMessage(@Nullable
                        java.lang.Object message,
                        @Nonnull
                        PostMessageOptions options)

The postMessage() method of the Worker interface sends a message to the worker's inner scope. This accepts a single parameter, which is the data to send to the worker. The data may be any value or JavaScript object handled by the structured clone algorithm, which includes cyclical references.

See Also:

Worker.postMessage - MDN, Worker.postMessage() - HTML Living Standard

postMessage

public void postMessage(@Nullable
                        java.lang.Object message)

The postMessage() method of the Worker interface sends a message to the worker's inner scope. This accepts a single parameter, which is the data to send to the worker. The data may be any value or JavaScript object handled by the structured clone algorithm, which includes cyclical references.

See Also:

Worker.postMessage - MDN, Worker.postMessage() - HTML Living Standard

terminate

public void terminate()

The terminate() method of the Worker interface immediately terminates the Worker. This does not offer the worker an opportunity to finish its operations; it is simply stopped at once.

See Also:

Worker.terminate - MDN, Worker.terminate() - HTML Living Standard

addMessageListener

@JsOverlay
public final void addMessageListener(@Nonnull
                                                MessageEventListener callback,
                                                @Nonnull
                                                AddEventListenerOptions options)

addMessageListener

@JsOverlay
public final void addMessageListener(@Nonnull
                                                MessageEventListener callback,
                                                boolean useCapture)

addMessageListener

@JsOverlay
public final void addMessageListener(@Nonnull
                                                MessageEventListener callback)

removeMessageListener

@JsOverlay
public final void removeMessageListener(@Nonnull
                                                   MessageEventListener callback,
                                                   @Nonnull
                                                   EventListenerOptions options)

removeMessageListener

@JsOverlay
public final void removeMessageListener(@Nonnull
                                                   MessageEventListener callback,
                                                   boolean useCapture)

removeMessageListener

@JsOverlay
public final void removeMessageListener(@Nonnull
                                                   MessageEventListener callback)

addMessageerrorListener

@JsOverlay
public final void addMessageerrorListener(@Nonnull
                                                     MessageEventListener callback,
                                                     @Nonnull
                                                     AddEventListenerOptions options)

addMessageerrorListener

@JsOverlay
public final void addMessageerrorListener(@Nonnull
                                                     MessageEventListener callback,
                                                     boolean useCapture)

addMessageerrorListener

@JsOverlay
public final void addMessageerrorListener(@Nonnull
                                                     MessageEventListener callback)

removeMessageerrorListener

@JsOverlay
public final void removeMessageerrorListener(@Nonnull
                                                        MessageEventListener callback,
                                                        @Nonnull
                                                        EventListenerOptions options)

removeMessageerrorListener

@JsOverlay
public final void removeMessageerrorListener(@Nonnull
                                                        MessageEventListener callback,
                                                        boolean useCapture)

removeMessageerrorListener

@JsOverlay
public final void removeMessageerrorListener(@Nonnull
                                                        MessageEventListener callback)