aboutsummaryrefslogtreecommitdiff
path: root/files/ja/web/api/sharedworker/index.html
blob: 9e504bc1552a5f1bae5b77e9cc293b26900eb6a2 (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
105
106
107
---
title: SharedWorker
slug: Web/API/SharedWorker
translation_of: Web/API/SharedWorker
---
<div>{{APIRef("Web Workers API")}}</div>

<p><code><strong>SharedWorker</strong></code> インターフェースは複数のブラウザコンテキストからアクセス可能な Worker を提供します。複数のブラウザコンテキストとは、複数のウィンドウや iframe、Worker などを指します。Dedicated Worker とは異なるインタフェースと、異なるグローバルスコープを持ちます。スコープに関しては {{domxref("SharedWorkerGlobalScope")}} を参照してください。</p>

<div class="note">
<p><strong>付記:</strong>同じオリジン、つまりプロトコル、ホスト名、ポートが全て同じ場合にのみ、SharedWorker は異なるブラウザコンテキスト間で共有されます。</p>
</div>

<h2 id="コンストラクタ">コンストラクタ</h2>

<dl>
 <dt>{{domxref("SharedWorker.SharedWorker", "SharedWorker()")}}</dt>
 <dd>指定された URL のスクリプトを実行する SharedWorker を作成します。</dd>
</dl>

<h2 id="プロパティ">プロパティ</h2>

<p><em>{{domxref("EventTarget")}} のプロパティを継承し、 {{domxref("AbstractWorker")}} で定義されるプロパティを実装しています。</em></p>

<dl>
 <dt>{{domxref("AbstractWorker.onerror")}}</dt>
 <dd>type <code>error</code> である {{domxref("ErrorEvent")}} がバブリングした時に呼ばれる {{domxref("EventListener")}}</dd>
 <dt>{{domxref("SharedWorker.port")}} {{readonlyInline}}</dt>
 <dd>通信とコントロールに利用される {{domxref("MessagePort")}} オブジェクトを返します。</dd>
</dl>

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

<p><em>{{domxref("EventTarget")}} のメソッドを継承し、 {{domxref("AbstractWorker")}} に定義されるメソッドを実装します。</em></p>

<h2 id="例"></h2>

<p><a class="external external-icon" href="https://github.com/mdn/simple-shared-worker">SharedWorker の基本利用例</a> (<a class="external external-icon" href="http://mdn.github.io/simple-shared-worker/">ライブデモ</a>) には 2 つの HTML ページがあり、それぞれでは JavaScript で単純な計算を行っています。それぞれのスクリプトは計算を行うために同じ JS ファイルを Worker に実行させています。2 つのページが別のウインドウで動作していたとしても、同じ Worker にアクセスできています。</p>

<p><code>SharedWorker</code> オブジェクトは {{domxref("SharedWorker.SharedWorker", "SharedWorker()")}} コンストラクタを利用して、次のように作成します:</p>

<pre class="brush: js">var myWorker = new SharedWorker("worker.js");
</pre>

<p>それぞれのスクリプトは {{domxref("MessagePort")}} オブジェクトを通じて Worker にアクセスします。このオブジェクトは {{domxref("SharedWorker.port")}} プロパティから取得できます。addEventListener を読んで onmessage イベントのハンドラを登録したら、<code>start()</code> メソッドを呼んでポートを手動で開始できます:</p>

<pre class="brush: js">myWorker.port.start();</pre>

<p>ポートが開始されたら、Worker に向けてメッセージを送ったり、送られたメッセージを受け取ったりできます。これらには <code>port.postMessage()</code><code>port.onmessage</code> を利用します:</p>

<pre class="brush: js">first.onchange = function() {
    myWorker.port.postMessage([first.value,second.value]);
    console.log('Message posted to worker');
  }

  second.onchange = function() {
    myWorker.port.postMessage([first.value,second.value]);
    console.log('Message posted to worker');
  }

  myWorker.port.onmessage = function(e) {
    result1.textContent = e.data;
    console.log('Message received from worker');
  }</pre>

<p>Worker の内部では {{domxref("SharedWorkerGlobalScope.onconnect")}} に対してハンドラを設定することで、上述したポートへの接続を処理できます。Worker に関連付けられたポートは  {{event("connect")}} イベントの <code>ports</code> 属性で参照できます。{{domxref("MessagePort")}} <code>の start()</code> メソッドによるポート開始後は、<code>onmessage</code> ハンドラでメインスレッドからのメッセージを処理します。</p>

<pre class="brush: js">onconnect = function(e) {
    var port = e.ports[0];

    port.addEventListener('message', function(e) {
      var workerResult = 'Result: ' + (e.data[0] * e.data[1]);
      port.postMessage(workerResult);
    });

    port.start(); // Required when using addEventListener. Otherwise called implicitly by onmessage setter.
}</pre>

<h2 id="仕様">仕様</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', "#sharedworker", "SharedWorker")}}</td>
   <td>{{Spec2('HTML WHATWG')}}</td>
   <td>{{SpecName("Web Workers")}} との差分なし</td>
  </tr>
 </tbody>
</table>

<h2 id="ブラウザ互換性">ブラウザ互換性</h2>



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

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

<ul>
 <li>{{domxref("Worker")}}</li>
 <li><a class="internal" href="/docs/Web/Guide/Performance/Using_web_workers">Web workers の利用</a></li>
</ul>