elemental.events

Interface MessagePort

All Superinterfaces:

EventTarget

All Known Implementing Classes:

JsMessagePort

public interface MessagePort
extends EventTarget

dom/interfaces/threads/nsIDOMWorkers.idlScriptable

This interface represents a worker thread's message port, which is used to allow the worker to post messages back to its creator.

1.0

11.0

Introduced

Gecko 1.9.1

Inherits from: nsISupports Last changed in Gecko 1.9.1 (Firefox 3.5 / Thunderbird 3.0 / SeaMonkey 2.0)

Method Summary

Methods

Modifier and Type	Method and Description
EventRemover	addEventListener(String type, EventListener listener) Register an event handler of a specific event type on the EventTarget.
EventRemover	addEventListener(String type, EventListener listener, boolean useCapture) Register an event handler of a specific event type on the EventTarget.
void	close()
boolean	dispatchEvent(Event evt) Dispatch an event to this EventTarget.
EventListener	getOnmessage()
void	postMessage(String message) Posts a message into the event queue.
void	postMessage(String message, Indexable messagePorts) Posts a message into the event queue.
void	removeEventListener(String type, EventListener listener) Removes an event listener from the EventTarget.
void	removeEventListener(String type, EventListener listener, boolean useCapture) Removes an event listener from the EventTarget.
void	setOnmessage(EventListener arg)
void	start()
void	webkitPostMessage(String message)
void	webkitPostMessage(String message, Indexable transfer)

Method Detail

getOnmessage

EventListener getOnmessage()

setOnmessage

void setOnmessage(EventListener arg)

addEventListener

EventRemover addEventListener(String type,
                            EventListener listener)

Description copied from interface: EventTarget

Register an event handler of a specific event type on the EventTarget.

Specified by:

addEventListener in interface EventTarget

addEventListener

EventRemover addEventListener(String type,
                            EventListener listener,
                            boolean useCapture)

Description copied from interface: EventTarget

Register an event handler of a specific event type on the EventTarget.

Specified by:

addEventListener in interface EventTarget

close

void close()

dispatchEvent

boolean dispatchEvent(Event evt)

Description copied from interface: EventTarget

Dispatch an event to this EventTarget.

Specified by:

dispatchEvent in interface EventTarget

postMessage

void postMessage(String message)

Posts a message into the event queue.

Parameters

aMessage

The message to post.

postMessage

void postMessage(String message,
               Indexable messagePorts)

Posts a message into the event queue.

Parameters

aMessage

The message to post.

removeEventListener

void removeEventListener(String type,
                       EventListener listener)

Description copied from interface: EventTarget

Removes an event listener from the EventTarget.

Specified by:

removeEventListener in interface EventTarget

removeEventListener

void removeEventListener(String type,
                       EventListener listener,
                       boolean useCapture)

Description copied from interface: EventTarget

Removes an event listener from the EventTarget.

Specified by:

removeEventListener in interface EventTarget

start

void start()

webkitPostMessage

void webkitPostMessage(String message)

webkitPostMessage

void webkitPostMessage(String message,
                     Indexable transfer)