aboutsummaryrefslogtreecommitdiff
path: root/files/ja/web/api/messageport/index.html
blob: c586aef559fa52f58731912bf4b8db5e10bda561 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
---
title: MessagePort
slug: Web/API/MessagePort
tags:
  - API
  - Channel messaging
  - HTML5
  - Interface
  - MessagePort
  - Reference
translation_of: Web/API/MessagePort
---
<p>{{APIRef("HTML DOM")}}</p>

<p><a href="/ja/docs/Web/API/Channel_Messaging_API">Channel Messaging API</a><strong><code>MessagePort</code></strong> インターフェースは、{{domxref("MessageChannel")}} の 2 つのポートの一方を表し、片方のポートから送信されるメッセージをもう片方のポートで受信待機できます。</p>

<p>{{AvailableInWorkers}}</p>

<h2 id="Methods" name="Methods">メソッド</h2>

<p><em>親である {{domxref("EventTarget")}} からのメソッドを継承します。</em></p>

<dl>
 <dt>{{domxref("MessagePort.postMessage")}}</dt>
 <dd>ポートからメッセージを送信します。また、任意でオブジェクトの所有権を他のブラウジングコンテキストへ転送します。</dd>
 <dt>{{domxref("MessagePort.start")}}</dt>
 <dd>ポート上で順番待ちのメッセージの送信を開始します。({{domxref("EventTarget.addEventListener")}} を使用する場合のみ必要。これは、{{domxref("MessagePort.onmessage")}} を使用する場合を含みます)</dd>
 <dt>{{domxref("MessagePort.close")}}</dt>
 <dd>ポートとの接続を切断し、このポートはアクティブではなくなります。</dd>
</dl>

<h2 id="Event_handlers" name="Event_handlers">イベントハンドラ</h2>

<p><em>親である {{domxref("EventTarget")}} からのイベントハンドラを継承します。</em></p>

<dl>
 <dt>{{domxref("MessagePort.onmessage")}}</dt>
 <dd>これは、<code>message</code> 型の {{domxref("MessageEvent")}} がポート上で発動した時に呼び出される {{domxref("EventListener")}} です。つまり、ポートがメッセージを受信した時に呼び出されます。</dd>
 <dt>{{domxref("MessagePort.onmessageerror")}}</dt>
 <dd>ポートで <code>messageerror</code> 型の {{domxref("MessageEvent")}} が発火すると呼び出されます。つまり、デシリアライズできないメッセージを受け取ったときです。</dd>
</dl>

<h2 id="Example" name="Example"></h2>

<p>次のコードブロックには、{{domxref("MessageChannel()", "MessageChannel.MessageChannel")}} コンストラクタで作成された新しいチャンネルがあります。</p>

<p>Iframe が読み込まれると、{{domxref("MessageChannel.port1")}}<code>onmessage</code> ハンドラーを登録し、メッセージと共に {{domxref("window.postMessage")}} を使用して IFrame に {{domxref("MessageChannel.port2")}} を送信します。</p>

<p>IFrame からメッセージが返却されると。<code>onMessage</code> 関数でメッセージをパラグラフに出力します。</p>

<pre>var channel = new MessageChannel();
var output = document.querySelector('.output');
var iframe = document.querySelector('iframe');

// Wait for the iframe to load
iframe.addEventListener("load", onLoad);

function onLoad() {
  // Listen for messages on port1
  channel.port1.onmessage = onMessage;

  // Transfer port2 to the iframe
  iframe.contentWindow.postMessage('Hello from the main page!', '*', [channel.port2]);
}


// Handle messages received on port1
function onMessage(e) {
  output.innerHTML = e.data;
}
</pre>

<p>完全に動作する例は、Github 上の <a class="external external-icon" href="https://github.com/mdn/channel-messaging-basic-demo">channel messaging basic demo</a> を参照してください (<a class="external external-icon" href="http://mdn.github.io/channel-messaging-basic-demo/">実際のデモも実行できます</a>)。</p>

<h2 id="Specifications" name="Specifications">仕様</h2>

<table class="standard-table">
 <tbody>
  <tr>
   <th scope="col">仕様書</th>
   <th scope="col">策定状況</th>
   <th scope="col">備考</th>
  </tr>
  <tr>
   <td>{{SpecName('HTML WHATWG', 'web-messaging.html#message-ports','Message ports')}}</td>
   <td>{{Spec2('HTML WHATWG')}}</td>
   <td> </td>
  </tr>
 </tbody>
</table>

<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザの実装状況</h2>

<div>


<p>{{Compat("api.MessagePort")}}</p>
</div>

<h2 id="See_also" name="See_also">関連情報</h2>

<ul>
 <li><a href="/docs/Web/API/Channel_Messaging_API/Using_channel_messaging">Using channel messaging</a></li>
</ul>