akasha

Class MessagePort

java.lang.Object

akasha.EventTarget

akasha.MessagePort

All Implemented Interfaces:

Transferable

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

The MessagePort interface of the Channel Messaging API represents one of the two ports of a MessageChannel, allowing messages to be sent from one port and listening out for them arriving at the other.

See Also:

MessagePort - MDN, Message ports - HTML Living Standard

Field Summary

Fields

Modifier and Type	Field and Description
MessageEventHandler	onmessage The onmessage event handler of the MessagePort interface is an EventListener, called whenever an MessageEvent of type message is fired on the port — that is, when the port receives a message.
MessageEventHandler	onmessageerror The onmessageerror event handler of the MessagePort interface is an EventListener, called whenever an MessageEvent of type messageerror is fired on the port—that is, when it receives a message that cannot be deserialized.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MessagePort()

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	close() The close() method of the MessagePort interface disconnects the port, so it is no longer active.
void	postMessage(java.lang.Object message) The postMessage() method of the MessagePort interface sends a message from the port, and optionally, transfers ownership of objects to other browsing contexts.
void	postMessage(java.lang.Object message, JsArray<Transferable> transfer) The postMessage() method of the MessagePort interface sends a message from the port, and optionally, transfers ownership of objects to other browsing contexts.
void	postMessage(java.lang.Object message, PostMessageOptions options) The postMessage() method of the MessagePort interface sends a message from the port, and optionally, transfers ownership of objects to other browsing contexts.
void	postMessage(java.lang.Object message, Transferable[] transfer) The postMessage() method of the MessagePort interface sends a message from the port, and optionally, transfers ownership of objects to other browsing contexts.
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	start() The start() method of the MessagePort interface starts the sending of messages queued on the port.

Methods inherited from class akasha.EventTarget

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

Methods inherited from class java.lang.Object

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

Field Detail

onmessage

@Nullable
public MessageEventHandler onmessage

The onmessage event handler of the MessagePort interface is an EventListener, called whenever an MessageEvent of type message is fired on the port — that is, when the port receives a message.

See Also:

MessagePort.onmessage - MDN, onmessage - HTML Living Standard

onmessageerror

@Nullable
public MessageEventHandler onmessageerror

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

See Also:

MessagePort.onmessageerror - MDN, onmessageerror - HTML Living Standard

Constructor Detail

MessagePort

protected MessagePort()

Method Detail

close

public void close()

The close() method of the MessagePort interface disconnects the port, so it is no longer active. This stops the flow of messages to that port.

See Also:

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

postMessage

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

The postMessage() method of the MessagePort interface sends a message from the port, and optionally, transfers ownership of objects to other browsing contexts.

See Also:

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

postMessage

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

The postMessage() method of the MessagePort interface sends a message from the port, and optionally, transfers ownership of objects to other browsing contexts.

See Also:

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

postMessage

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

The postMessage() method of the MessagePort interface sends a message from the port, and optionally, transfers ownership of objects to other browsing contexts.

See Also:

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

postMessage

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

The postMessage() method of the MessagePort interface sends a message from the port, and optionally, transfers ownership of objects to other browsing contexts.

See Also:

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

start

public void start()

The start() method of the MessagePort interface starts the sending of messages queued on the port. This method is only needed when using EventTarget.addEventListener; it is implied when using MessageChannel.onmessage.

See Also:

MessagePort.start - MDN, start() - 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)