akasha

Class DedicatedWorkerGlobalScope

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.WorkerGlobalScope

akasha.DedicatedWorkerGlobalScope

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

The DedicatedWorkerGlobalScope object (the Worker global scope) is accessible through the self keyword. Some additional global functions, namespaces objects, and constructors, not typically associated with the worker global scope, but available on it, are listed in the JavaScript Reference. See also: Functions available to workers.

See Also:

DedicatedWorkerGlobalScope - MDN, (HTML) # dedicated-workers-and-the-dedicatedworkerglobalscope-interface

Field Summary

Fields

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

Fields inherited from class akasha.WorkerGlobalScope

onerror, onlanguagechange, onoffline, ononline, onrejectionhandled, onunhandledrejection

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DedicatedWorkerGlobalScope()

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	cancelAnimationFrame(int handle)
void	close() The close() method of the DedicatedWorkerGlobalScope interface discards any tasks queued in the DedicatedWorkerGlobalScope's event loop, effectively closing this particular scope.
java.lang.String	name() The name read-only property of the DedicatedWorkerGlobalScope interface returns the name that the Worker was (optionally) given when it was created.
void	postMessage(java.lang.Object message) The postMessage() method of the DedicatedWorkerGlobalScope interface sends a message to the main thread that spawned it.
void	postMessage(java.lang.Object message, JsArray<Transferable> transfer) The postMessage() method of the DedicatedWorkerGlobalScope interface sends a message to the main thread that spawned it.
void	postMessage(java.lang.Object message, StructuredSerializeOptions options) The postMessage() method of the DedicatedWorkerGlobalScope interface sends a message to the main thread that spawned it.
void	postMessage(java.lang.Object message, Transferable... transfer) The postMessage() method of the DedicatedWorkerGlobalScope interface sends a message to the main thread that spawned it.
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)
int	requestAnimationFrame(FrameRequestCallback callback)

Methods inherited from class akasha.WorkerGlobalScope

addLanguagechangeListener, addLanguagechangeListener, addLanguagechangeListener, addOfflineListener, addOfflineListener, addOfflineListener, addOnlineListener, addOnlineListener, addOnlineListener, addRejectionhandledListener, addRejectionhandledListener, addRejectionhandledListener, addUnhandledrejectionListener, addUnhandledrejectionListener, addUnhandledrejectionListener, atob, btoa, caches, clearInterval, clearInterval, clearTimeout, clearTimeout, createImageBitmap, createImageBitmap, createImageBitmap, createImageBitmap, crossOriginIsolated, crypto, fetch, fetch, fetch, fetch, fetch, fetch, importScripts, indexedDB, isIndexedDBSupported, isSecureContext, location, navigator, origin, performance, queueMicrotask, removeLanguagechangeListener, removeLanguagechangeListener, removeLanguagechangeListener, removeOfflineListener, removeOfflineListener, removeOfflineListener, removeOnlineListener, removeOnlineListener, removeOnlineListener, removeRejectionhandledListener, removeRejectionhandledListener, removeRejectionhandledListener, removeUnhandledrejectionListener, removeUnhandledrejectionListener, removeUnhandledrejectionListener, reportError, self, setInterval, setInterval, setTimeout, setTimeout, structuredClone, structuredClone

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

onmessage

public @JsNullable MessageEventHandler onmessage

The onmessage property of the DedicatedWorkerGlobalScope interface represents an EventHandler to be called when the message event occurs and bubbles through the Worker — i.e. when a message is sent to the worker using the Worker.postMessage method.

See Also:

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

onmessageerror

public @JsNullable MessageEventHandler onmessageerror

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

See Also:

DedicatedWorkerGlobalScope.onmessageerror - MDN, onmessageerror - HTML Living Standard

Constructor Detail

DedicatedWorkerGlobalScope

protected DedicatedWorkerGlobalScope()

Method Detail

name

@JsProperty(name="name")
 @Nonnull
public java.lang.String name()

The name read-only property of the DedicatedWorkerGlobalScope interface returns the name that the Worker was (optionally) given when it was created. This is the name that the Worker() constructor can pass to get a reference to the DedicatedWorkerGlobalScope.

See Also:

DedicatedWorkerGlobalScope.name - MDN, name - HTML Living Standard

close

public void close()

The close() method of the DedicatedWorkerGlobalScope interface discards any tasks queued in the DedicatedWorkerGlobalScope's event loop, effectively closing this particular scope.

See Also:

DedicatedWorkerGlobalScope.close - MDN, close() - HTML Living Standard

postMessage

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

The postMessage() method of the DedicatedWorkerGlobalScope interface sends a message to the main thread that spawned it. 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:

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

postMessage

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

The postMessage() method of the DedicatedWorkerGlobalScope interface sends a message to the main thread that spawned it. 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:

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

postMessage

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

The postMessage() method of the DedicatedWorkerGlobalScope interface sends a message to the main thread that spawned it. 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:

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

postMessage

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

The postMessage() method of the DedicatedWorkerGlobalScope interface sends a message to the main thread that spawned it. 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:

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

cancelAnimationFrame

public void cancelAnimationFrame(int handle)

requestAnimationFrame

public int requestAnimationFrame(@Nonnull
                                 FrameRequestCallback callback)

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)