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.
Inherits methods from its parent, EventTarget
MessagePort.postMessage
MessagePort.start
EventTarget.addEventListener
; it is implied when using MessagePort.onmessage
.)MessagePort.close
Inherits event handlers from its parent, EventTarget
MessagePort.onmessage
EventListener
called when a MessageEvent
of type message
is fired on the port—that is, when the port receives a message.MessagePort.onmessageerror
EventListener
called when a MessageEvent
of type MessageError
is fired—that is, when it receives a message that cannot be deserialized.In the following code block, you can see a new channel being created using the MessageChannel.MessageChannel
constructor. When the IFrame has loaded, we transfer MessageChannel.port2
(a MessagePort
) to the IFrame using MessagePort.postMessage
along with a message. The handleMessage
handler then responds to a message being sent back from the IFrame (using MessagePort.onmessage
), putting it into a paragraph.
var channel = new MessageChannel(); var para = document.querySelector('p'); var ifr = document.querySelector('iframe'); var otherWindow = ifr.contentWindow; ifr.addEventListener("load", iframeLoaded, false); function iframeLoaded() { otherWindow.postMessage('Hello from the main page!', '*', [channel.port2]); } channel.port1.onmessage = handleMessage; function handleMessage(e) { para.innerHTML = e.data; }
For a full working example, see our channel messaging basic demo on Github (run it live too).
Specification | Status | Comment |
---|---|---|
HTML Living Standard The definition of 'Message ports' in that specification. | Living Standard |
Feature | Chrome | Edge | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
---|---|---|---|---|---|---|
Basic support | 4 | (Yes) | (Yes) | 10.0 | 10.6 | 5 |
Available in workers | (Yes) | ? | 41 (41) | (Yes) | (Yes) | (Yes) |
onmessageerror | 60 | ? | 57 (57) | ? | 47 | ? |
Feature | Android Webview | Chrome for Android | Edge | Firefox Mobile (Gecko) | Firefox OS (Gecko) | IE Phone | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|---|---|---|
Basic support | (Yes) | 4 | (Yes) | No support | No support | 10.0 | 11.5 | 5.1 |
Available in workers | (Yes) | (Yes) | ? | 41.0 (41) | (Yes) | (Yes) | (Yes) | (Yes) |
onmessageerror | 60 | 60 | ? | 57.0 (57) | 47 | ? | 47 | ? |
© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/MessagePort