/[suikacvs]/markup/html/html5/spec-ja/.workers-spec.en.html
Suika

Contents of /markup/html/html5/spec-ja/.workers-spec.en.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.174 - (hide annotations) (download) (as text)
Mon Oct 19 06:18:38 2009 UTC (16 years, 5 months ago) by wakaba
Branch: MAIN
Changes since 1.173: +5 -3 lines
File MIME type: text/html
make

1 wakaba 1.130 <!DOCTYPE html><html lang=en-US-x-hixie><meta charset=ascii><title>Web Workers</title><link href=/style/specification rel=stylesheet><link href=/images/icon rel=icon><body class=draft>
2 wakaba 1.171
3     <header class=head><p><a class=logo href=http://www.whatwg.org/ rel=home><img alt=WHATWG src=/images/logo></a></p>
4     <hgroup><h1>Web Workers</h1>
5 wakaba 1.174 <h2 class="no-num no-toc">Draft Recommendation &mdash; 18 October 2009</h2>
6 wakaba 1.171 </hgroup><p>You can take part in this work. <a href=http://www.whatwg.org/mailing-list>Join the working group's discussion list.</a></p>
7 wakaba 1.82 <p><strong>Web designers!</strong> We have a <a href=http://blog.whatwg.org/faq/>FAQ</a>, a <a href=http://forums.whatwg.org/>forum</a>, and a <a href=http://www.whatwg.org/mailing-list#help>help mailing list</a> for you!</p>
8 wakaba 1.130 <dl><dt>This version:</dt>
9 wakaba 1.82 <dd><a href=http://www.whatwg.org/specs/web-workers/current-work/>http://whatwg.org/ww</a></dd>
10     <dt>Version history:</dt>
11     <dd>Twitter messages (non-editorial changes only): <a href=http://twitter.com/WHATWG>http://twitter.com/WHATWG</a></dd>
12     <dd>Commit-Watchers mailing list: <a href=http://lists.whatwg.org/listinfo.cgi/commit-watchers-whatwg.org>http://lists.whatwg.org/listinfo.cgi/commit-watchers-whatwg.org</a></dd>
13     <dd>Interactive Web interface: <a href=http://html5.org/tools/web-workers-tracker>http://html5.org/tools/web-workers-tracker</a></dd>
14     <dd>Subversion interface: <a href=http://svn.whatwg.org/webworkers/>http://svn.whatwg.org/webworkers/</a></dd>
15     <dt>Issues:</dt>
16     <dd>To send feedback: <a href=http://www.whatwg.org/mailing-list>whatwg@whatwg.org</a></dd>
17     <dd>To view and vote on feedback: <a href=http://www.whatwg.org/issues/>http://www.whatwg.org/issues/</a></dd>
18     <dt>Editor:</dt>
19     <dd>Ian Hickson, Google, ian@hixie.ch</dd>
20 wakaba 1.130 </dl><p class=copyright>&copy; Copyright 2004-2008 Apple Computer, Inc.,
21 wakaba 1.82 Mozilla Foundation, and Opera Software ASA.</p>
22     <p class=copyright>You are granted a license to use, reproduce
23     and create derivative works of this document.</p>
24 wakaba 1.171 </header><hr><h2 class="no-num no-toc" id=abstract>Abstract</h2>
25 wakaba 1.82
26     <p>This specification defines an API that allows Web application
27     authors to spawn background workers running scripts in parallel to
28     their main page. This allows for thread-like operation with
29     message-passing as the coordination mechanism.</p>
30    
31    
32     <h2 class="no-num no-toc" id=status>Status of this document</h2>
33    
34     <p><strong>This is a work in progress!</strong> This document is
35     changing on a daily if not hourly basis in response to comments and
36     as a general part of its development process. Comments are very
37     welcome, please send them to <a href=mailto:whatwg@whatwg.org>whatwg@whatwg.org</a>. Thank
38     you.</p>
39    
40     <p>The current focus is in developing a first draft proposal.</p>
41    
42     <p>Implementors should be aware that this specification is not
43     stable. <strong>Implementors who are not taking part in the
44     discussions are likely to find the specification changing out from
45     under them in incompatible ways.</strong> Vendors interested in
46     implementing this specification before it eventually reaches the
47     call for implementations should join the <a href=/mailing-list>WHATWG mailing list</a> and take part in the
48     discussions.</p>
49    
50     <p>This specification is also being produced by the <a href=http://www.w3.org/2008/webapps/>W3C Web Apps WG</a>. The two
51     specifications are identical from the table of contents onwards.</p>
52    
53     <h2 class="no-num no-toc" id=contents>Table of contents</h2>
54    
55     <!--begin-toc-->
56     <ol class=toc>
57     <li><a href=#introduction><span class=secno>1 </span>Introduction</a>
58     <ol>
59     <li><a href=#scope><span class=secno>1.1 </span>Scope</a></li>
60     <li><a href=#tutorial><span class=secno>1.2 </span>Tutorial</a>
61     <ol>
62     <li><a href=#a-background-number-crunching-worker><span class=secno>1.2.1 </span>A background number-crunching worker</a></li>
63     <li><a href=#a-worker-for-updating-a-client-side-database><span class=secno>1.2.2 </span>A worker for updating a client-side database</a></li>
64     <li><a href=#worker-used-for-background-i/o><span class=secno>1.2.3 </span>Worker used for background I/O</a></li>
65     <li><a href=#shared-workers><span class=secno>1.2.4 </span>Shared workers</a></li>
66     <li><a href=#delegation><span class=secno>1.2.5 </span>Delegation</a></li>
67     <li><a href=#providing-libraries><span class=secno>1.2.6 </span>Providing libraries</a></ol></ol></li>
68 wakaba 1.110 <li><a href=#conformance-requirements><span class=secno>2 </span>Conformance requirements</a>
69 wakaba 1.82 <ol>
70 wakaba 1.110 <li><a href=#dependencies><span class=secno>2.1 </span>Dependencies</a></ol></li>
71     <li><a href=#terminology><span class=secno>3 </span>Terminology</a></li>
72     <li><a href=#infrastructure><span class=secno>4 </span>Infrastructure</a>
73     <ol>
74     <li><a href=#the-global-scope><span class=secno>4.1 </span>The global scope</a>
75 wakaba 1.82 <ol>
76 wakaba 1.110 <li><a href=#the-workerglobalscope-abstract-interface><span class=secno>4.1.1 </span>The <code>WorkerGlobalScope</code> abstract interface</a></li>
77     <li><a href=#dedicated-workers-and-the-dedicatedworkerglobalscope-interface><span class=secno>4.1.2 </span>Dedicated workers and the <code>DedicatedWorkerGlobalScope</code> interface</a></li>
78     <li><a href=#shared-workers-and-the-sharedworkerglobalscope-inteface><span class=secno>4.1.3 </span>Shared workers and the <code>SharedWorkerGlobalScope</code> inteface</a></ol></li>
79 wakaba 1.141 <li><a href=#origins-of-workers><span class=secno>4.2 </span>Origins of workers</a></li>
80 wakaba 1.172 <li><a href=#the-event-loop><span class=secno>4.3 </span>The event loop</a></li>
81     <li><a href="#the-worker's-lifetime"><span class=secno>4.4 </span>The worker's lifetime</a></li>
82     <li><a href=#processing-model><span class=secno>4.5 </span>Processing model</a></li>
83     <li><a href=#runtime-script-errors><span class=secno>4.6 </span>Runtime script errors</a></li>
84     <li><a href=#creating-workers><span class=secno>4.7 </span>Creating workers</a>
85 wakaba 1.82 <ol>
86 wakaba 1.172 <li><a href=#the-abstractworker-abstract-interface><span class=secno>4.7.1 </span>The <code>AbstractWorker</code> abstract interface</a></li>
87     <li><a href=#dedicated-workers-and-the-worker-interface><span class=secno>4.7.2 </span>Dedicated workers and the <code>Worker</code> interface</a></li>
88     <li><a href=#shared-workers-and-the-sharedworker-interface><span class=secno>4.7.3 </span>Shared workers and the <code>SharedWorker</code> interface</a></ol></ol></li>
89 wakaba 1.110 <li><a href=#apis-available-to-workers><span class=secno>5 </span>APIs available to workers</a>
90 wakaba 1.82 <ol>
91 wakaba 1.110 <li><a href=#importing-scripts-and-libraries><span class=secno>5.1 </span>Importing scripts and libraries</a></li>
92     <li><a href=#the-navigator-object><span class=secno>5.2 </span>The <code title=worker-Navigator>Navigator</code> object</a></li>
93     <li><a href=#apis-defined-in-other-specifications><span class=secno>5.3 </span>APIs defined in other specifications</a></li>
94     <li><a href=#interface-objects-and-constructors><span class=secno>5.4 </span>Interface objects and constructors</a></li>
95     <li><a href=#worker-locations><span class=secno>5.5 </span>Worker locations</a></ol></li>
96 wakaba 1.82 <li><a class=no-num href=#references>References</a></li>
97     <li><a class=no-num href=#acknowledgements>Acknowledgements</a></ol>
98     <!--end-toc-->
99 wakaba 1.130 <hr><h2 id=introduction><span class=secno>1 </span>Introduction</h2>
100 wakaba 1.82
101     <h3 id=scope><span class=secno>1.1 </span>Scope</h3>
102    
103 wakaba 1.106 <p><i>This section is non-normative.</i></p>
104 wakaba 1.82
105     <p>This specification defines an API for running scripts in the
106     background independently of any user interface scripts.</p>
107    
108     <p>This allows for long-running scripts that are not interrupted by
109     scripts that respond to clicks or other user interactions, and
110     allows long tasks to be executed without yielding to keep the page
111     responsive.</p>
112    
113     <p>Workers (as these background scripts are called herein) are
114     relatively heavy-weight, and are not intended to be used in large
115     numbers. For example, it would be inappropriate to launch one worker
116     for each pixel of a four megapixel image. The examples below show
117     some appropriate uses of workers.</p>
118    
119     <p>Generally, workers are expected to be long-lived, have a high
120     start-up performance cost, and a high per-instance memory cost.</p>
121    
122    
123     <h3 id=tutorial><span class=secno>1.2 </span>Tutorial</h3>
124    
125 wakaba 1.106 <p><i>This section is non-normative.</i></p>
126 wakaba 1.82
127     <p>There are a variety of uses that workers can be put to. The
128     following subsections show various examples of this use.</p>
129    
130     <h4 id=a-background-number-crunching-worker><span class=secno>1.2.1 </span>A background number-crunching worker</h4>
131    
132 wakaba 1.106 <p><i>This section is non-normative.</i></p>
133 wakaba 1.82
134     <p>The simplest use of workers is for performing a computationally
135     expensive task without interrupting the user interface.</p>
136    
137     <p>In this example, the main document spawns a worker to
138 wakaba 1.130 (na&iuml;vely) compute prime numbers, and progressively displays the
139 wakaba 1.82 most recently found prime number.</p>
140    
141     <p>The main page is as follows:</p>
142    
143     <pre>&lt;!DOCTYPE HTML&gt;
144     &lt;html&gt;
145     &lt;head&gt;
146     &lt;title&gt;Worker example: One-core computation&lt;/title&gt;
147     &lt;/head&gt;
148     &lt;body&gt;
149     &lt;p&gt;The highest prime number discovered so far is: &lt;output id="result"&gt;&lt;/output&gt;&lt;/p&gt;
150     &lt;script&gt;
151     var worker = new Worker('worker.js');
152     worker.onmessage = function (event) {
153     document.getElementById('result').textContent = event.data;
154     };
155     &lt;/script&gt;
156     &lt;/body&gt;
157     &lt;/html&gt;</pre>
158    
159     <p>The <code title=dom-Worker><a href=#dom-worker>Worker()</a></code> constructor call
160     creates a worker and returns a <code><a href=#worker>Worker</a></code> object
161     representing that worker, which is used to communicate with the
162 wakaba 1.162 worker. That object's <code title=handler-Worker-onmessage><a href=#handler-worker-onmessage>onmessage</a></code> event handler allows the code to receive messages from the worker.</p>
163 wakaba 1.82
164     <p>The worker itself is as follows:</p>
165    
166     <pre>var n = 1;
167     search: while (true) {
168     n += 1;
169     for (var i = 2; i &lt;= Math.sqrt(n); i += 1)
170     if (n % i == 0)
171     continue search;
172     // found a prime!
173     postMessage(n);
174     }</pre>
175    
176     <p>The bulk of this code is simply an unoptimized search for a prime
177     number. To send a message back to the page, the <code title=dom-DedicatedWorkerGlobalScope-postMessage><a href=#dom-dedicatedworkerglobalscope-postmessage>postMessage()</a></code>
178     method is used to post a message when a prime is found.</p>
179    
180     <p><a href=http://www.whatwg.org/demos/workers/primes/page.html>View this example online</a>.</p>
181    
182    
183    
184     <h4 id=a-worker-for-updating-a-client-side-database><span class=secno>1.2.2 </span>A worker for updating a client-side database</h4>
185    
186 wakaba 1.106 <p><i>This section is non-normative.</i></p>
187 wakaba 1.82
188     <p>In this example, the main document spawns a worker whose only
189     task is to listen for notifications from the server, and, when
190     appropriate, either add or remove data from the client-side
191     database.</p>
192    
193     <p>Since no communication occurs between the worker and the main
194     page, the main page can start the worker by just doing:</p>
195    
196     <pre>&lt;script&gt;
197     new Worker('worker.js');
198     &lt;/script&gt;</pre>
199    
200     <p>The worker itself is as follows:</p>
201    
202     <pre>var server = new WebSocket('ws://whatwg.org/database');
203     var database = openDatabase('demobase', '1.0', 'Demo Database', 10240);
204     server.onmessage = function (event) {
205     // data is in the format "command key value"
206     var data = event.data.split(' ');
207     switch (data[0]) {
208     case '+':
209     database.transaction(function(tx) {
210     tx.executeSql('INSERT INTO pairs (key, value) VALUES (?, ?)', data[1], data[2]);
211     });
212     case '-':
213     database.transaction(function(tx) {
214     tx.executeSql('DELETE FROM pairs WHERE key=? AND value=?', data[1], data[2]);
215     });
216     }
217     };</pre>
218    
219     <p>This connects to the server using the <code>WebSocket</code>
220     mechanism and opens the local database (which, we presume, has been
221     created earlier). The worker then just listens for messages from the
222     server and acts on them as appropriate, forever (or until the main
223     page is closed).</p>
224    
225     <p><a href=http://www.whatwg.org/demos/workers/database-updater/page.html>View
226     this example online</a>. (This example will not actually function,
227     since the server does not actually exist and the database is not
228     created by this sample code.)</p>
229    
230    
231    
232     <h4 id=worker-used-for-background-i/o><span class=secno>1.2.3 </span>Worker used for background I/O</h4>
233    
234 wakaba 1.106 <p><i>This section is non-normative.</i></p>
235 wakaba 1.82
236     <p>In this example, the main document uses two workers, one for
237     fetching stock updates for at regular intervals, and one for
238     fetching performing search queries that the user requests.</p>
239    
240     <p>The main page is as follows:</p>
241    
242     <pre>&lt;!DOCTYPE HTML&gt;
243     &lt;html&gt;
244     &lt;head&gt;
245     &lt;title&gt;Worker example: Stock ticker&lt;/title&gt;
246     &lt;script&gt;
247     // TICKER
248     var symbol = 'GOOG'; // default symbol to watch
249     var ticker = new Worker('ticker.js');
250    
251     // SEARCHER
252     var searcher = new Worker('searcher.js');
253     function search(query) {
254     searcher.postMessage(query);
255     }
256    
257     // SYMBOL SELECTION UI
258     function select(newSymbol) {
259     symbol = newSymbol;
260     ticker.postMessage(symbol);
261     }
262     &lt;/script&gt;
263     &lt;/head&gt;
264     &lt;body onload="search('')"&gt;
265     &lt;p&gt;&lt;output id="symbol"&gt;&lt;/output&gt; &lt;output id="value"&gt;&lt;/output&gt;&lt;/p&gt;
266     &lt;script&gt;
267     ticker.onmessage = function (event) {
268     var data = event.data.split(' ');
269     document.getElementById('symbol').textContent = data[0];
270     document.getElementById('value').textContent = data[1];
271     };
272     ticker.postMessage(symbol);
273     &lt;/script&gt;
274     &lt;p&gt;&lt;label&gt;Search: &lt;input type="text" autofocus oninput="search(this.value)"&gt;&lt;/label&gt;&lt;/p&gt;
275     &lt;ul id="results"&gt;&lt;/ul&gt;
276     &lt;script&gt;
277     searcher.onmessage = function (event) {
278     var data = event.data.split(' ');
279     var results = document.getElementById('results');
280     while (results.hasChildNodes()) // clear previous results
281     results.removeChild(results.firstChild);
282     for (var i = 0; i &lt; data.length; i += 1) {
283     // add a list item with a button for each result
284     var li = document.createElement('li');
285     var button = document.createElement('button');
286     button.value = data[i];
287     button.type = 'button';
288     button.onclick = function () { select(this.value); };
289     button.textContent = data[i];
290     li.appendChild(button);
291     results.appendChild(li);
292     }
293     };
294     &lt;/script&gt;
295     &lt;p&gt;(The data in this example is not real. Try searching for "Google" or "Apple".)&lt;/p&gt;
296     &lt;/body&gt;
297     &lt;/html&gt;</pre>
298    
299     <p>The two workers use a common library for performing the actual
300     network calls. This library is as follows:</p>
301    
302     <pre>function get(url) {
303     try {
304     var xhr = new XMLHttpRequest();
305     xhr.open('GET', url, false);
306     xhr.send();
307     return xhr.responseText;
308     } catch (e) {
309     return ''; // turn all errors into empty results
310     }
311     }</pre>
312    
313     <p>The stock updater worker is as follows:</p>
314    
315     <pre>importScripts('io.js');
316     var timer;
317     var symbol;
318     function update() {
319     postMessage(symbol + ' ' + get('stock.cgi?' + symbol));
320     timer = setTimeout(update, 10000);
321     }
322     onmessage = function (event) {
323     if (timer)
324     clearTimeout(timer);
325     symbol = event.data;
326     update();
327     };</pre>
328    
329     <p>The search query worker is as follows:</p>
330    
331     <pre>importScripts('io.js');
332     onmessage = function (event) {
333     postMessage(get('search.cgi?' + event.data));
334     };</pre>
335    
336     <p><a href=http://www.whatwg.org/demos/workers/stocks/page.html>View this example online</a>.</p>
337    
338    
339     <h4 id=shared-workers><span class=secno>1.2.4 </span>Shared workers</h4>
340    
341 wakaba 1.106 <p><i>This section is non-normative.</i></p>
342 wakaba 1.82
343     <p>In this example, multiple windows (viewers) can be opened that
344     are all viewing the same map. All the windows share the same map
345     information, with a single worker coordinating all the viewers. Each
346     viewer can move around independently, but if they set any data on
347     the map, all the viewers are updated.</p>
348    
349     <p>The main page isn't interesting, it merely provides a way to open
350     the viewers:</p>
351    
352     <pre>&lt;!DOCTYPE HTML&gt;
353     &lt;html&gt;
354     &lt;head&gt;
355     &lt;title&gt;Workers example: Multiviewer&lt;/title&gt;
356     &lt;script&gt;
357     function openViewer() {
358     window.open('viewer.html');
359     }
360     &lt;/script&gt;
361     &lt;/head&gt;
362     &lt;body&gt;
363     &lt;p&gt;&lt;button type=button onclick="openViewer()"&gt;Open a new
364     viewer&lt;/button&gt;&lt;/p&gt;
365     &lt;p&gt;Each viewer opens in a new window. You can have as many viewers
366     as you like, they all view the same data.&lt;/p&gt;
367     &lt;/body&gt;
368     &lt;/html&gt;</pre>
369    
370     <p>The viewer is more involved:</p>
371    
372     <pre>&lt;!DOCTYPE HTML&gt;
373     &lt;html&gt;
374     &lt;head&gt;
375     &lt;title&gt;Workers example: Multiviewer viewer&lt;/title&gt;
376     &lt;script&gt;
377     var worker = new SharedWorker('worker.js', 'core');
378    
379     // CONFIGURATION
380     function configure(event) {
381     if (event.data.substr(0, 4) != 'cfg ') return;
382     var name = event.data.substr(4).split(' ', 1);
383     // update display to mention our name is name
384     document.getElementsByTagName('h1')[0].textContent += ' ' + name;
385     // no longer need this listener
386     worker.port.removeEventListener('message', configure, false);
387     }
388     worker.port.addEventListener('message', configure, false);
389    
390     // MAP
391     function paintMap(event) {
392     if (event.data.substr(0, 4) != 'map ') return;
393     var data = event.data.substr(4).split(',');
394     // display tiles data[0] .. data[8]
395     var canvas = document.getElementById('map');
396     var context = canvas.getContext('2d');
397     for (var y = 0; y &lt; 3; y += 1) {
398     for (var x = 0; x &lt; 3; x += 1) {
399     var tile = data[y * 3 + x];
400     if (tile == '0')
401     context.fillStyle = 'green';
402     else
403     context.fillStyle = 'maroon';
404     fillRect(x * 50, y * 50, 50, 50);
405     }
406     }
407     }
408     worker.port.addEventListener('message', paintMap, false);
409    
410     // PUBLIC CHAT
411     function updatePublicChat(event) {
412     if (event.data.substr(0, 4) != 'txt ') return;
413     var name = event.data.substr(4).split(' ', 1);
414     var message = event.data.substr(4 + length(name) + 1);
415     // display "&lt;name&gt; message" in public chat
416     var dialog = document.getElementById('public');
417     var dt = document.createElement('dt');
418     dt.textContent = name;
419     dialog.appendChild(dt);
420     var dd = document.createElement('dd');
421     dd.textContent = message;
422     dialog.appendChild(dd);
423     }
424     worker.port.addEventListener('message', updatePublicChat, false);
425    
426     // PRIVATE CHAT
427     function startPrivateChat(event) {
428     if (event.data.substr(0, 4) != 'msg ') return;
429     var name = event.data.substr(4).split(' ', 1);
430     var port = event.ports[0];
431     // display a private chat UI
432     var ul = document.getElementById('private');
433     var li = document.createElement('li');
434     var h3 = document.createElement('h3');
435     h3.textContent = 'Private chat with ' + name;
436     li.appendChild(h3);
437     var dialog = document.createElement('dialog');
438     var addMessage = function(name, message) {
439     var dt = document.createElement('dt');
440     dt.textContent = name;
441     dialog.appendChild(dt);
442     var dd = document.createElement('dd');
443     dd.textContent = message;
444     dialog.appendChild(dd);
445     };
446     port.onmessage = function (event) {
447     addMessage(name, event.data);
448     };
449     li.appendChild(dialog);
450     var form = document.createElement('form');
451     var p = document.createElement('p');
452     var input = document.createElement('input');
453     input.size = 50;
454     p.appendChild(input);
455     p.appendChild(document.createTextNode(' '));
456     var button = document.createElement('button');
457     button.textContent = 'Post';
458     p.appendChild(button);
459     form.onsubmit = function () {
460     port.postMessage(input.value);
461     addMessage('me', input.value);
462     input.value = '';
463     return false;
464     };
465     form.appendChild(p);
466     li.appendChild(form);
467     }
468     worker.port.addEventListener('message', startPrivateChat, false);
469 wakaba 1.174
470     worker.port.start();
471 wakaba 1.82 &lt;/script&gt;
472     &lt;/head&gt;
473     &lt;body&gt;
474     &lt;h1&gt;Viewer&lt;/h1&gt;
475     &lt;h2&gt;Map&lt;/h2&gt;
476     &lt;p&gt;&lt;canvas id="map" height=150 width=150&gt;&lt;/canvas&gt;&lt;/p&gt;
477     &lt;p&gt;
478     &lt;button type=button onclick="worker.port.postMessage('mov left')"&gt;Left&lt;/button&gt;
479     &lt;button type=button onclick="worker.port.postMessage('mov up')"&gt;Up&lt;/button&gt;
480     &lt;button type=button onclick="worker.port.postMessage('mov down')"&gt;Down&lt;/button&gt;
481     &lt;button type=button onclick="worker.port.postMessage('mov right')"&gt;Right&lt;/button&gt;
482     &lt;button type=button onclick="worker.port.postMessage('set 0')"&gt;Set 0&lt;/button&gt;
483     &lt;button type=button onclick="worker.port.postMessage('set 1')"&gt;Set 1&lt;/button&gt;
484     &lt;/p&gt;
485     &lt;h2&gt;Public Chat&lt;/h2&gt;
486     &lt;dialog id="public"&gt;&lt;/dialog&gt;
487     &lt;form onsubmit="worker.port.postMessage('txt ' + message.value); message.value = ''; return false;"&gt;
488     &lt;p&gt;
489     &lt;input type="text" name="message" size="50"&gt;
490     &lt;button&gt;Post&lt;/button&gt;
491     &lt;/p&gt;
492     &lt;/form&gt;
493     &lt;h2&gt;Private Chat&lt;/h2&gt;
494     &lt;ul id="private"&gt;&lt;/ul&gt;
495     &lt;/body&gt;
496     &lt;/html&gt;
497     </pre>
498    
499     <p>There are several key things worth noting about the way the
500     viewer is written.</p>
501    
502     <p><strong>Multiple listeners</strong>. Instead of a single message
503     processing function, the code here attaches multiple event
504     listeners, each one performing a quick check to see if it is
505     relevant for the message. In this example it doesn't make much
506     difference, but if multiple authors wanted to collaborate using a
507     single port to communicate with a worker, it would allow for
508     independent code instead of changes having to all be made to a
509     single event handling function.</p>
510    
511     <p>Registering event listeners in this way also allows you to
512     unregister specific listeners when you are done with them, as is
513     done with the <code title="">configure()</code> method in this
514     example.</p>
515    
516     <p>Finally, the worker:</p>
517    
518 wakaba 1.130 <pre>
519     var nextName = 0;
520 wakaba 1.82 function getNextName() {
521     // this could use more friendly names
522     // but for now just return a number
523     return nextName++;
524     }
525    
526     var map = [
527     [0, 0, 0, 0, 0, 0, 0],
528     [1, 1, 0, 1, 0, 1, 1],
529     [0, 1, 0, 1, 0, 0, 0],
530     [0, 1, 0, 1, 0, 1, 1],
531     [0, 0, 0, 1, 0, 0, 0],
532     [1, 0, 0, 1, 1, 1, 1],
533     [1, 1, 0, 1, 1, 0, 1],
534     ];
535    
536     function wrapX(x) {
537     if (x &lt; 0) return wrapX(x + map[0].length);
538     if (x &gt;= map[0].length) return wrapX(x - map[0].length);
539     return x;
540     }
541    
542     function wrapY(y) {
543     if (y &lt; 0) return wrapY(y + map.length);
544     if (y &gt;= map[0].length) return wrapY(y - map.length);
545     return y;
546     }
547    
548     function sendMapData(callback) {
549     var data = '';
550     for (var y = viewer.y-1; y &lt;= viewer.y+1; y += 1) {
551     for (var x = viewer.x-1; x &lt;= viewer.x+1; x += 1) {
552     if (data != '')
553     data += ',';
554     data += map[y][x];
555     }
556     }
557     callback('map ' + data);
558     }
559    
560     var viewers = {};
561     onconnect = function (event) {
562     event.ports[0]._name = getNextName();
563     event.ports[0]._data = { port: event.port, x: 0, y: 0, };
564     viewers[event.ports[0]._name] = event.port._data;
565     event.ports[0].postMessage('cfg ' + name);
566     event.ports[0].onmessage = getMessage;
567     sendMapData(event.ports[0].postMessage);
568     };
569    
570     function getMessage(event) {
571     switch (event.data.substr(0, 4)) {
572     case 'mov ':
573     var direction = event.data.substr(4);
574     var dx = 0;
575     var dy = 0;
576     switch (direction) {
577     case 'up': dy = -1; break;
578     case 'down': dy = 1; break;
579     case 'left': dx = -1; break;
580     case 'right': dx = 1; break;
581     }
582     event.target._data.x = wrapX(event.target._data.x + dx);
583     event.target._data.y = wrapY(event.target._data.y + dy);
584     sendMapData(event.target.postMessage);
585     break;
586     case 'set ':
587     var value = event.data.substr(4);
588     map[event.target._data.y][event.target._data.x] = value;
589     for (var viewer in viewers)
590     sendMapData(viewers[viewer].port.postMessage);
591     break;
592     case 'txt ':
593     var name = event.target._name;
594     var message = event.data.substr(4);
595     for (var viewer in viewers)
596     viewers[viewer].port.postMessage('txt ' + name + ' ' + message);
597     break;
598     case 'msg ':
599     var party1 = event._data;
600     var party2 = viewers[event.data.substr(4).split(' ', 1)];
601     if (party2) {
602     var channel = new MessageChannel();
603     party1.port.postMessage('msg ' + party2.name, [channel.port1]);
604     party2.port.postMessage('msg ' + party1.name, [channel.port2]);
605     }
606     break;
607     }
608     }</pre>
609    
610     <p><strong>Connecting to multiple pages</strong>. The script uses
611     the <code title=handler-SharedWorkerGlobalScope-onconnect><a href=#handler-sharedworkerglobalscope-onconnect>onconnect</a></code>
612     event listener to listen for multiple connections.</p>
613    
614     <p><strong>Direct channels</strong>. When the worker receives a
615     "msg" message from one viewer naming another viewer, it sets up a
616     direct connection between the two, so that the two viewers can
617     communicate directly without the worker having to proxy all the
618     messages.</p>
619    
620     <p><a href=http://www.whatwg.org/demos/workers/multiviewer/page.html>View this example online</a>.</p>
621    
622    
623     <h4 id=delegation><span class=secno>1.2.5 </span>Delegation</h4>
624    
625 wakaba 1.106 <p><i>This section is non-normative.</i></p>
626 wakaba 1.82
627     <p>With multicore CPUs becoming prevalent, one way to obtain better
628     performance is to split computationally expensive tasks amongst
629     multiple workers. In this example, a computationally expensive task
630     that is to be performed for every number from 1 to 10,000,000 is
631     farmed out to ten subworkers.</p>
632    
633     <p>The main page is as follows, it just reports the result:</p>
634    
635     <pre>&lt;!DOCTYPE HTML&gt;
636     &lt;html&gt;
637     &lt;head&gt;
638     &lt;title&gt;Worker example: One-core computation&lt;/title&gt;
639     &lt;/head&gt;
640     &lt;body&gt;
641     &lt;p&gt;The highest prime number discovered so far is: &lt;output id="result"&gt;&lt;/output&gt;&lt;/p&gt;
642     &lt;script&gt;
643     var worker = new Worker('worker.js');
644     worker.onmessage = function (event) {
645     document.getElementById('result').textContent = event.data;
646     };
647     &lt;/script&gt;
648     &lt;/body&gt;
649     &lt;/html&gt;</pre>
650    
651     <p>The worker itself is as follows:</p>
652    
653     <pre>// settings
654     var num_workers = 10;
655     var items_per_worker = 1000000;
656    
657     // start the workers
658     var result = 0;
659     var pending_workers = num_workers;
660     for (var i = 0; i &lt; num_workers; i += 1) {
661     var worker = new Worker('core.js');
662     worker.postMessage(i * items_per_worker);
663     worker.postMessage((i+1) * items_per_worker);
664     worker.onmessage = storeResult;
665     }
666    
667     // handle the results
668     function storeResult(event) {
669     result += 1*event.data;
670     pending_workers -= 1;
671     if (pending_workers &lt;= 0)
672     postMessage(result); // finished!
673     }</pre>
674    
675     <p>It consists of a loop to start the subworkers, and then a handler
676     that waits for all the subworkers to respond.</p>
677    
678     <p>The subworkers are implemented as follows:</p>
679    
680     <pre>var start;
681     onmessage = getStart;
682     function getStart(event) {
683     start = 1*event.data;
684     onmessage = getEnd;
685     }
686    
687     var end;
688     function getEnd(event) {
689     end = 1*event.data;
690     onmessage = null;
691     work();
692     }
693    
694     function work() {
695     var result = 0;
696     for (var i = start; i &lt; end; i += 1) {
697     // perform some complex calculation here
698     result += 1;
699     }
700     postMessage(result);
701     close();
702     }</pre>
703    
704     <p>They receive two numbers in two events, perform the computation
705     for the range of numbers thus specified, and then report the result
706     back to the parent.</p>
707    
708     <p><a href=http://www.whatwg.org/demos/workers/multicore/page.html>View this example online</a>.</p>
709    
710    
711     <h4 id=providing-libraries><span class=secno>1.2.6 </span>Providing libraries</h4>
712    
713 wakaba 1.106 <p><i>This section is non-normative.</i></p>
714 wakaba 1.82
715     <p>Suppose that a cryptography library is made available that
716     provides three tasks:</p>
717    
718 wakaba 1.130 <dl><dt>Generate a public/private key pair</dt>
719 wakaba 1.82
720     <dd>Takes a port, on which it will send two messages, first the
721     public key and then the private key.</dd>
722    
723     <dt>Given a plaintext and a public key, return the corresponding cyphertext</dt>
724    
725     <dd>Takes a port, to which any number of messages can be sent, the
726     first giving the public key, and the remainder giving the
727     plaintext, each of which is encrypted and then sent on that same
728     channel as the cyphertext. The user can close the port when it is
729     done encrypting content.</dd>
730    
731     <dt>Given a cyphertext and a private key, return the corresponding plaintext</dt>
732    
733     <dd>Takes a port, to which any number of messages can be sent, the
734     first giving the private key, and the remainder giving the
735     cyphertext, each of which is decrypted and then sent on that same
736     channel as the plaintext. The user can close the port when it is
737     done decrypting content.</dd>
738    
739 wakaba 1.130 </dl><p>The library itself is as follows:</p>
740 wakaba 1.82
741     <pre>function handleMessage(e) {
742     if (e.data == "genkeys")
743     genkeys(e.ports[0]);
744     else if (e.data == "encrypt")
745     encrypt(e.ports[0]);
746     else if (e.data == "decrypt")
747     decrypt(e.ports[0]);
748     }
749    
750     function genkeys(p) {
751     var keys = _generateKeyPair();
752     p.postMessage(keys[0]);
753     p.postMessage(keys[1]);
754     }
755    
756     function encrypt(p) {
757     var key, state = 0;
758     p.onmessage = function (e) {
759     if (state == 0) {
760     key = e.data;
761     state = 1;
762     } else {
763     p.postMessage(_encrypt(key, e.data));
764     }
765     };
766     }
767    
768     function decrypt(p) {
769     var key, state = 0;
770     p.onmessage = function (e) {
771     if (state == 0) {
772     key = e.data;
773     state = 1;
774     } else {
775     p.postMessage(_decrypt(key, e.data));
776     }
777     };
778     }
779    
780     // support being used as a shared worker as well as a dedicated worker
781     if (this.onmessage) // dedicated worker
782     onmessage = handleMessage;
783     else // shared worker
784     onconnect = function (e) { e.port.onmessage = handleMessage; }
785    
786    
787     // the "crypto" functions:
788    
789     function _generateKeyPair() {
790     return [Math.random(), Math.random()];
791     }
792    
793     function _encrypt(k, s) {
794     return 'encrypted-' + k + ' ' + s;
795     }
796    
797     function _decrypt(k, s) {
798     return s.substr(s.indexOf(' ')+1);
799     }</pre>
800    
801     <p>Note that the crypto functions here are just stubs and don't do
802     real cryptography.</p>
803    
804     <p>This library could be used as follows:</p>
805    
806     <pre>&lt;!DOCTYPE HTML&gt;
807     &lt;html&gt;
808     &lt;head&gt;
809     &lt;title&gt;Worker example: Crypto library&lt;/title&gt;
810     &lt;script&gt;
811     var crytoLib = new Worker('libcrypto-v1.js'); // or could use 'libcrypto-v2.js'
812     function getKeys() {
813     var state = 0;
814     cryptoLib.startConversation("genkeys").onmessage = function (e) {
815     if (state == 0)
816     document.getElementById('public').value = e.data;
817     else if (state == 1)
818     document.getElementById('private').value = e.data;
819     state += 1;
820     };
821     }
822     function enc() {
823     var port = cryptoLib.startConversation("encrypt");
824     port.postMessage(document.getElementById('public').value);
825     port.postMessage(document.getElementById('input').value);
826     port.onmessage = function (e) {
827     document.getElementById('input').value = e.data;
828     port.close();
829     };
830     }
831     function dec() {
832     var port = cryptoLib.startConversation("decrypt");
833     port.postMessage(document.getElementById('private').value);
834     port.postMessage(document.getElementById('input').value);
835     port.onmessage = function (e) {
836     document.getElementById('input').value = e.data;
837     port.close();
838     };
839     }
840     &lt;/script&gt;
841     &lt;style&gt;
842     textarea { display: block; }
843     &lt;/style&gt;
844     &lt;/head&gt;
845     &lt;body onload="getKeys()"&gt;
846     &lt;fieldset&gt;
847     &lt;legend&gt;Keys&lt;/legend&gt;
848     &lt;p&gt;&lt;label&gt;Public Key: &lt;textarea id="public"&gt;&lt;/textarea&gt;&lt;/label&gt;&lt;/p&gt;
849     &lt;p&gt;&lt;label&gt;Private Key: &lt;textarea id="private"&gt;&lt;/textarea&gt;&lt;/label&gt;&lt;/p&gt;
850     &lt;/fieldset&gt;
851     &lt;p&gt;&lt;label&gt;Input: &lt;textarea id="input"&gt;&lt;/textarea&gt;&lt;/label&gt;&lt;/p&gt;
852     &lt;p&gt;&lt;button onclick="enc()"&gt;Encrypt&lt;/button&gt; &lt;button onclick="dec()"&gt;Decrypt&lt;/button&gt;&lt;/p&gt;
853     &lt;/body&gt;
854     &lt;/html&gt;</pre>
855    
856     <p>A later version of the API, though, might want to offload all the
857     crypto work onto subworkers. This could be done as follows:</p>
858    
859     <pre>function handleMessage(e) {
860     if (e.data == "genkeys")
861     genkeys(e.ports[0]);
862     else if (e.data == "encrypt")
863     encrypt(e.ports[0]);
864     else if (e.data == "decrypt")
865     decrypt(e.ports[0]);
866     }
867    
868     function genkeys(p) {
869     var generator = new Worker('libcrypto-v2-generator.js');
870     generator.postMessage('', [p]);
871     }
872    
873     function encrypt(p) {
874     p.onmessage = function (e) {
875     var key = e.data;
876     var encryptor = new Worker('libcrypto-v2-encryptor.js');
877     encryptor.postMessage(key, [p]);
878     };
879     }
880    
881     function encrypt(p) {
882     p.onmessage = function (e) {
883     var key = e.data;
884     var decryptor = new Worker('libcrypto-v2-decryptor.js');
885     decryptor.postMessage(key, [p]);
886     };
887     }
888    
889     // support being used as a shared worker as well as a dedicated worker
890     if (this.onmessage) // dedicated worker
891     onmessage = handleMessage;
892     else // shared worker
893     onconnect = function (e) { e.ports[0].onmessage = handleMessage };
894     </pre>
895    
896     <p>The little subworkers would then be as follows.</p>
897    
898     <p>For generating key pairs:</p>
899    
900     <pre>onmessage = function (e) {
901     var k = _generateKeyPair();
902     e.ports[0].postMessage(k[0]);
903     e.ports[0].postMessage(k[1]);
904     close();
905     }
906    
907     function _generateKeyPair() {
908     return [Math.random(), Math.random()];
909     }</pre>
910    
911     <p>For encrypting:</p>
912    
913     <pre>onmessage = function (e) {
914     var key = e.data;
915     e.ports[0].onmessage = function (e) {
916     var s = e.data;
917     postMessage(_encrypt(key, s));
918     }
919     }
920    
921     function _encrypt(k, s) {
922     return 'encrypted-' + k + ' ' + s;
923     }</pre>
924    
925     <p>For decrypting:</p>
926    
927     <pre>onmessage = function (e) {
928     var key = e.data;
929     e.ports[0].onmessage = function (e) {
930     var s = e.data;
931     postMessage(_decrypt(key, s));
932     }
933     }
934    
935     function _decrypt(k, s) {
936     return s.substr(s.indexOf(' ')+1);
937     }</pre>
938    
939     <p>Notice how the users of the API don't have to even know that this
940 wakaba 1.130 is happening &mdash; the API hasn't changed; the library can
941 wakaba 1.82 delegate to subworkers without changing its API, even though it is
942     accepting data using message channels.</p>
943    
944     <p><a href=http://www.whatwg.org/demos/workers/crypto/page.html>View this example online</a>.</p>
945    
946    
947    
948    
949     <h2 id=conformance-requirements><span class=secno>2 </span>Conformance requirements</h2>
950    
951     <p>All diagrams, examples, and notes in this specification are
952     non-normative, as are all sections explicitly marked non-normative.
953     Everything else in this specification is normative.</p>
954    
955     <p>The key words "MUST", "MUST NOT", "REQUIRED", <!--"SHALL", "SHALL
956     NOT",--> "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and
957     "OPTIONAL" in the normative parts of this document are to be
958     interpreted as described in RFC2119. For readability, these words do
959     not appear in all uppercase letters in this specification. <a href=#refsRFC2119>[RFC2119]</a></p>
960    
961     <p>Requirements phrased in the imperative as part of algorithms
962     (such as "strip any leading space characters" or "return false and
963     abort these steps") are to be interpreted with the meaning of the
964     key word ("must", "should", "may", etc) used in introducing the
965     algorithm.</p>
966    
967     <p>Some conformance requirements are phrased as requirements on
968     attributes, methods or objects. Such requirements are to be
969     interpreted as requirements on user agents.</p>
970    
971     <p>Conformance requirements phrased as algorithms or specific steps
972     may be implemented in any manner, so long as the end result is
973     equivalent. (In particular, the algorithms defined in this
974     specification are intended to be easy to follow, and not intended to
975     be performant.)</p>
976    
977     <p>The only conformance class defined by this specification is user
978     agents.</p>
979    
980     <p>User agents may impose implementation-specific limits on
981     otherwise unconstrained inputs, e.g. to prevent denial of service
982     attacks, to guard against running out of memory, or to work around
983     platform-specific limitations.</p>
984    
985    
986 wakaba 1.110 <h3 id=dependencies><span class=secno>2.1 </span>Dependencies</h3>
987 wakaba 1.82
988     <p>This specification relies on several other underlying
989     specifications.</p>
990    
991 wakaba 1.130 <dl><dt>HTML5</dt>
992 wakaba 1.82
993     <dd>
994    
995     <p>Many fundamental concepts from HTML5 are used by this
996     specification. <a href=#refsHTML5>[HTML5]</a></p>
997    
998     </dd>
999    
1000     <dt>WebIDL</dt>
1001    
1002     <dd>
1003    
1004     <p>The IDL blocks in this specification use the semantics of the
1005 wakaba 1.129 WebIDL specification. <a href=#refsWEBIDL>[WEBIDL]</a></p>
1006 wakaba 1.82
1007     </dd>
1008    
1009 wakaba 1.130 </dl><h2 id=terminology><span class=secno>3 </span>Terminology</h2>
1010 wakaba 1.82
1011     <p>The construction "a <code title="">Foo</code> object", where
1012     <code title="">Foo</code> is actually an interface, is sometimes
1013     used instead of the more accurate "an object implementing the
1014     interface <code title="">Foo</code>".</p>
1015    
1016     <p>The term DOM is used to refer to the API set made available to
1017     scripts in Web applications, and does not necessarily imply the
1018     existence of an actual <code>Document</code> object or of any other
1019     <code>Node</code> objects as defined in the DOM Core
1020 wakaba 1.129 specifications. <a href=#refsDOMCORE>[DOMCORE]</a></p>
1021 wakaba 1.82
1022 wakaba 1.154 <p>An IDL attribute is said to be <em>getting</em> when its value is
1023 wakaba 1.82 being retrieved (e.g. by author script), and is said to be
1024     <em>setting</em> when a new value is assigned to it.</p>
1025    
1026     <p>The term "JavaScript" is used to refer to ECMA262, rather than
1027     the official term ECMAScript, since the term JavaScript is more
1028     widely known. <a href=#refsECMA262>[ECMA262]</a></p>
1029    
1030    
1031 wakaba 1.110 <h2 id=infrastructure><span class=secno>4 </span>Infrastructure</h2>
1032 wakaba 1.82
1033     <p>There are two kinds of workers; dedicated workers, and shared
1034     workers. Dedicated workers, once created, and are linked to their
1035     creator; but message ports can be used to communicate from a
1036     dedicated worker to multiple other browsing contexts or
1037     workers. Shared workers, on the other hand, are named, and once
1038     created any script running in the same <span>origin</span> can
1039     obtain a reference to that worker and communicate with it.</p>
1040    
1041    
1042 wakaba 1.110 <h3 id=the-global-scope><span class=secno>4.1 </span>The global scope</h3>
1043 wakaba 1.82
1044     <p>The global scope is the "inside" of a worker.</p>
1045    
1046 wakaba 1.110 <h4 id=the-workerglobalscope-abstract-interface><span class=secno>4.1.1 </span>The <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> abstract interface</h4>
1047 wakaba 1.82
1048     <pre class=idl>interface <dfn id=workerglobalscope>WorkerGlobalScope</dfn> {
1049     readonly attribute <a href=#workerglobalscope>WorkerGlobalScope</a> <a href=#dom-workerglobalscope-self title=dom-WorkerGlobalScope-self>self</a>;
1050     readonly attribute <a href=#workerlocation>WorkerLocation</a> <a href=#dom-workerglobalscope-location title=dom-WorkerGlobalScope-location>location</a>;
1051    
1052     void <a href=#dom-workerglobalscope-close title=dom-WorkerGlobalScope-close>close</a>();
1053 wakaba 1.108 <!-- v2-onclose attribute <span>Function</span> <span title="handler-WorkerGlobalScope-onclose">onclose</span>;
1054     --> attribute <span>Function</span> <a href=#handler-workerglobalscope-onerror title=handler-WorkerGlobalScope-onerror>onerror</a>;
1055 wakaba 1.125 };
1056 wakaba 1.155 <a href=#workerglobalscope>WorkerGlobalScope</a> implements <a href=#workerutils>WorkerUtils</a>;
1057     <a href=#workerglobalscope>WorkerGlobalScope</a> implements <span>EventTarget</span>;</pre>
1058 wakaba 1.82
1059     <p>The <dfn id=dom-workerglobalscope-self title=dom-WorkerGlobalScope-self><code>self</code></dfn> attribute
1060     must return the <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object itself.</p>
1061    
1062     <p>The <dfn id=dom-workerglobalscope-location title=dom-WorkerGlobalScope-location><code>location</code></dfn>
1063     attribute must return the <code><a href=#workerlocation>WorkerLocation</a></code> object created
1064     for the <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object when the worker was
1065     created. It represents the <span>absolute URL</span> of the script
1066 wakaba 1.83 that was used to initialize the worker, after any redirects.</p>
1067 wakaba 1.82
1068 wakaba 1.130 <hr><p>When a script invokes the <dfn id=dom-workerglobalscope-close title=dom-WorkerGlobalScope-close><code>close()</code></dfn>
1069 wakaba 1.82 method on a <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object, the user agent
1070     must run the following steps (atomically):</p>
1071    
1072 wakaba 1.130 <ol><li><p>Discard any <span title=concept-task>tasks</span> that
1073 wakaba 1.82 have been added to the <span>event loop</span>'s <span title="task
1074     queue">task queues</span>.</p>
1075    
1076     <!-- v2-onclose
1077     <li><p><span>Queue a task</span> to <span>fire a simple
1078 wakaba 1.166 event</span> named <code title="event-close">close</code> at the
1079 wakaba 1.82 <code>WorkerGlobalScope</code> object.</p></li>
1080     -->
1081    
1082     <li><p>Set the worker's <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object's
1083     <a href=#dom-workerglobalscope-closing title=dom-WorkerGlobalScope-closing>closing</a> flag to
1084     true. (This prevents any further tasks from being queued.)</li>
1085    
1086     <li><p>Disentangle all the ports in the list of <a href="#the-worker's-ports">the worker's
1087     ports</a>.</li>
1088    
1089 wakaba 1.162 </ol><p>The following are the <span>event handlers</span> (and their
1090     corresponding <span title="event handler event type">event handler
1091     event types</span>) that must be supported, as IDL attributes, by
1092     objects implementing the <code><a href=#workerglobalscope>WorkerGlobalScope</a></code>
1093     interface:</p>
1094 wakaba 1.82
1095 wakaba 1.162 <table><thead><tr><th><span title="event handlers">Event handler</span> <th><span>Event handler event type</span>
1096 wakaba 1.130 <tbody><!-- v2-onclose <tr><td><dfn title="handler-WorkerGlobalScope-onclose"><code>onclose</code></dfn> <td> <code title="event-close">close</code> --><tr><td><dfn id=handler-workerglobalscope-onerror title=handler-WorkerGlobalScope-onerror><code>onerror</code></dfn> <td> <code title=event-error>error</code>
1097     </table><h4 id=dedicated-workers-and-the-dedicatedworkerglobalscope-interface><span class=secno>4.1.2 </span>Dedicated workers and the <code><a href=#dedicatedworkerglobalscope>DedicatedWorkerGlobalScope</a></code> interface</h4>
1098 wakaba 1.82
1099 wakaba 1.125 <pre class=idl>[Supplemental, NoInterfaceObject]
1100     interface <dfn id=dedicatedworkerglobalscope>DedicatedWorkerGlobalScope</dfn> : <a href=#workerglobalscope>WorkerGlobalScope</a> {
1101 wakaba 1.159 void <a href=#dom-dedicatedworkerglobalscope-postmessage title=dom-DedicatedWorkerGlobalScope-postMessage>postMessage</a>(in any message, in optional <span>MessagePortArray</span> ports);<!--
1102 wakaba 1.82 <span>MessagePort</span> <span title="dom-DedicatedWorkerGlobalScope-startConversation">startConversation</span>(in any message);-->
1103 wakaba 1.108 attribute <span>Function</span> <a href=#handler-dedicatedworkerglobalscope-onmessage title=handler-DedicatedWorkerGlobalScope-onmessage>onmessage</a>;
1104 wakaba 1.82 };</pre>
1105    
1106     <p><code><a href=#dedicatedworkerglobalscope>DedicatedWorkerGlobalScope</a></code> objects act as if they
1107     had an implicit <code>MessagePort</code> associated with them. This
1108     port is part of a channel that is set up when the worker is created,
1109     but it is not exposed. This object must never be garbage collected
1110     before the <code><a href=#dedicatedworkerglobalscope>DedicatedWorkerGlobalScope</a></code> object.</p>
1111    
1112     <p>All messages received by that port must immediately be retargeted
1113     at the <code><a href=#dedicatedworkerglobalscope>DedicatedWorkerGlobalScope</a></code> object.</p>
1114    
1115     <p>The <dfn id=dom-dedicatedworkerglobalscope-postmessage title=dom-DedicatedWorkerGlobalScope-postMessage><code>postMessage()</code></dfn><!--
1116     and <dfn
1117     title="dom-DedicatedWorkerGlobalScope-startConversation"><code>startConversation()</code></dfn>-->
1118     method<!--s (startConversation)--> on
1119     <code><a href=#dedicatedworkerglobalscope>DedicatedWorkerGlobalScope</a></code> objects must act as if, when
1120     invoked, it<!--/they (startConversation)--> immediately invoked the
1121     method of the same name on the port, with the same arguments, and
1122     returned the same return value.</p>
1123    
1124 wakaba 1.162 <p>The following are the <span>event handlers</span> (and their
1125     corresponding <span title="event handler event type">event handler
1126     event types</span>) that must be supported, as IDL attributes, by
1127     objects implementing the <code><a href=#dedicatedworkerglobalscope>DedicatedWorkerGlobalScope</a></code>
1128     interface:</p>
1129 wakaba 1.82
1130 wakaba 1.162 <table><thead><tr><th><span title="event handlers">Event handler</span> <th><span>Event handler event type</span>
1131 wakaba 1.130 <tbody><tr><td><dfn id=handler-dedicatedworkerglobalscope-onmessage title=handler-DedicatedWorkerGlobalScope-onmessage><code>onmessage</code></dfn> <td> <code title=event-message>message</code>
1132     </table><p>For the purposes of the <span>offline application cache</span>
1133 wakaba 1.82 networking model, a dedicated worker is an extension of the
1134     <span>cache host</span> from which it was created.</p>
1135    
1136    
1137    
1138 wakaba 1.110 <h4 id=shared-workers-and-the-sharedworkerglobalscope-inteface><span class=secno>4.1.3 </span>Shared workers and the <code><a href=#sharedworkerglobalscope>SharedWorkerGlobalScope</a></code> inteface</h4>
1139 wakaba 1.82
1140 wakaba 1.125 <pre class=idl>[Supplemental, NoInterfaceObject]
1141     interface <dfn id=sharedworkerglobalscope>SharedWorkerGlobalScope</dfn> : <a href=#workerglobalscope>WorkerGlobalScope</a> {
1142 wakaba 1.82 readonly attribute DOMString <a href=#dom-sharedworkerglobalscope-name title=dom-SharedWorkerGlobalScope-name>name</a>;
1143 wakaba 1.171 readonly attribute <span>ApplicationCache</span> <span title=dom-SharedWorkerGlobalScope-applicationCache>applicationCache</span>;
1144 wakaba 1.108 attribute <span>Function</span> <a href=#handler-sharedworkerglobalscope-onconnect title=handler-SharedWorkerGlobalScope-onconnect>onconnect</a>;
1145 wakaba 1.82 };</pre>
1146    
1147     <p>Shared workers receive message ports through <code title=event-WorkerGlobalScope-connect>connect</code> events on
1148     their global object for each connection.</p>
1149    
1150     <p>The <dfn id=dom-sharedworkerglobalscope-name title=dom-SharedWorkerGlobalScope-name><code>name</code></dfn>
1151     attribute must return the value it was assigned when the
1152     <code><a href=#sharedworkerglobalscope>SharedWorkerGlobalScope</a></code> object was created by the
1153     "<a href=#run-a-worker>run a worker</a>" algorithm. Its value represents the name
1154     that can be used to obtain a reference to the worker using the
1155     <code><a href=#sharedworker>SharedWorker</a></code> constructor.</p>
1156    
1157 wakaba 1.162 <p>The following are the <span>event handlers</span> (and their
1158     corresponding <span title="event handler event type">event handler
1159     event types</span>) that must be supported, as IDL attributes, by
1160     objects implementing the <code><a href=#sharedworkerglobalscope>SharedWorkerGlobalScope</a></code>
1161     interface:</p>
1162 wakaba 1.82
1163 wakaba 1.162 <table><thead><tr><th><span title="event handlers">Event handler</span> <th><span>Event handler event type</span>
1164 wakaba 1.130 <tbody><tr><td><dfn id=handler-sharedworkerglobalscope-onconnect title=handler-SharedWorkerGlobalScope-onconnect><code>onconnect</code></dfn> <td> <code title=event-connect>connect</code>
1165     </table><p>For the purposes of the <span>offline application cache</span>
1166 wakaba 1.82 networking model, a shared worker is its own <span>cache
1167     host</span>. The <a href=#run-a-worker>run a worker</a> algorithm takes care of
1168     associating the worker with an <span>application cache</span>.</p>
1169    
1170 wakaba 1.171 <p class=note>The <code title=dom-SharedWorkerGlobalScope-applicationCache>applicationCache</code>
1171 wakaba 1.82 attribute returns the <code>ApplicationCache</code> object for the
1172     worker.</p><!-- normative conf criteria is in the appcache section
1173     -->
1174    
1175    
1176 wakaba 1.141 <h3 id=origins-of-workers><span class=secno>4.2 </span>Origins of workers</h3>
1177 wakaba 1.82
1178     <p>Both the <span>origin</span> and <span>effective script
1179     origin</span> of scripts running in workers are the
1180     <span>origin</span> of the <span>absolute URL</span> given in that
1181     the worker's <code title=dom-WorkerGlobalScope-location><a href=#dom-workerglobalscope-location>location</a></code> attribute
1182     represents.</p>
1183    
1184    
1185    
1186 wakaba 1.172 <h3 id=the-event-loop><span class=secno>4.3 </span>The event loop</h3>
1187 wakaba 1.82
1188 wakaba 1.83 <p>Each <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object has an <span>event
1189     loop</span> distinct from those defined for <span title="unit of
1190     related similar-origin browsing contexts">units of related
1191     similar-origin browsing contexts</span>. This <span>event
1192     loop</span> has no associated <span>browsing context</span>, and its
1193     <span title="task queue">task queues</span> only have events,
1194     callbacks, and networking activity as <span title=concept-task>tasks</span>. The processing model of these
1195     <span title="event loop">event loops</span> is defined below in the
1196     <a href=#run-a-worker>run a worker</a> algorithm.</p>
1197 wakaba 1.82
1198     <p>Each <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object also has a <dfn id=dom-workerglobalscope-closing title=dom-WorkerGlobalScope-closing>closing</dfn> flag, which must
1199     initially be false, but which can get set to true by the algorithms
1200     in the processing model section below.</p>
1201    
1202     <p>Once the <code><a href=#workerglobalscope>WorkerGlobalScope</a></code>'s <a href=#dom-workerglobalscope-closing title=dom-WorkerGlobalScope-closing>closing</a> flag is set to
1203     true, the <span>event loop</span>'s <span title="task queue">task
1204     queues</span> must discard any further <span title=concept-task>tasks</span> that would be added to them (tasks
1205 wakaba 1.161 already on the queue are unaffected except where otherwise
1206 wakaba 1.82 specified). Effectively, once the <a href=#dom-workerglobalscope-closing title=dom-WorkerGlobalScope-closing>closing</a> flag is true,
1207     timers stop firing, notifications for all pending asynchronous
1208     operations are dropped, etc.</p>
1209    
1210    
1211 wakaba 1.104
1212 wakaba 1.172 <h3 id="the-worker's-lifetime"><span class=secno>4.4 </span>The worker's lifetime</h3>
1213 wakaba 1.82
1214     <p>Workers communicate with other workers and with <span title="browsing context">browsing contexts</span> through <span title="channel messaging">message channels</span> and their
1215     <code>MessagePort</code> objects.</p>
1216    
1217     <p>Each <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> <var title="">worker global
1218     scope</var> has a list of <dfn id="the-worker's-ports">the worker's ports</dfn>, which
1219     consists of all the <code>MessagePort</code> objects that are
1220     entangled with another port and that have one (but only one) port
1221     owned by <var title="">worker global scope</var>. This list includes
1222     <!--all the <code>MessagePort</code> objects that are in events
1223     pending in the <span>event loop</span>, as well as (commented out
1224     because in practice it makes no difference either way as far as I
1225     can tell, and it would be hard to strictly implement since these
1226     ports might not yet be across the thread boundary)--> the implicit
1227     <code>MessagePort</code> in the case of <a href=#dedicatedworkerglobalscope title=DedicatedWorkerGlobalScope>dedicated workers</a>.</p>
1228    
1229     <p>Each <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> also has a list of <dfn id="the-worker's-workers">the
1230     worker's workers</dfn>. Initially this list is empty; it is
1231     populated when the worker creates or obtains further workers.</p>
1232    
1233     <p>Finally, each <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> also has a list of
1234     <dfn id="the-worker's-documents">the worker's <code>Document</code>s</dfn>. Initially this list
1235     is empty; it is populated when the worker is created.</p>
1236    
1237     <p>Whenever a <code>Document</code> <var title="">d</var> is <dfn id="add-a-document-to-the-worker's-documents" title="add a document to the worker's documents">added to the
1238     worker's <code>Document</code>s</dfn>, the user agent must, for each
1239     worker in the list of <a href="#the-worker's-workers">the worker's workers</a> whose list
1240     of <a href="#the-worker's-documents">the worker's <code>Document</code>s</a> does not contain
1241     <var title="">d</var>, <a href="#add-a-document-to-the-worker's-documents" title="add a document to the worker's
1242     documents">add <var title="">d</var> to <var title="">q</var>'s
1243     <code>WorkerGlobalScope</code> owner's list of <span>the worker's
1244     <code>Document</code>s</span></a>.</p> <!-- suggestions welcome
1245     on making this sentence into understandable English -->
1246    
1247     <p>Whenever a <code>Document</code> object is <span title="discard a
1248     Document">discarded</span>, it must be removed from the list of
1249     <a href="#the-worker's-documents">the worker's <code>Document</code>s</a> of each worker
1250     whose list contains that <code>Document</code>.</p>
1251    
1252     <p>Given a <span>script's global scope</span> <var title="">o</var>
1253     when creating or obtaining a worker, the <dfn id=list-of-relevant-document-objects-to-add>list of relevant
1254     <code>Document</code> objects to add</dfn> depends on the type of
1255     <var title="">o</var>. If <var title="">o</var> is a
1256     <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object (i.e. if we are creating a
1257     nested worker), then the relevant <code>Document</code>s are the
1258     <code>Document</code>s that are in <var title="">o</var>'s own list
1259     of <a href="#the-worker's-documents">the worker's <code>Document</code>s</a>. Otherwise, <var title="">o</var> is a <code>Window</code> object, and the relevant
1260     <code>Document</code> is just the <code>Document</code> that is the
1261     <span>active document</span> of the <code>Window</code> object <var title="">o</var>.</p>
1262    
1263 wakaba 1.130 <hr><p>A worker is said to be a <dfn id=permissible-worker>permissible worker</dfn> if its
1264 wakaba 1.82 list of <a href="#the-worker's-documents">the worker's <code>Document</code>s</a> is not
1265     empty.</p>
1266    
1267     <p>A worker is said to be a <dfn id=protected-worker>protected worker</dfn> if it is a
1268     <a href=#permissible-worker>permissible worker</a> and either it has outstanding
1269     timers, database transactions, or network connections, or its list
1270     of <a href="#the-worker's-ports">the worker's ports</a> is not empty, or its
1271     <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> is actually a
1272     <code><a href=#sharedworkerglobalscope>SharedWorkerGlobalScope</a></code> object (i.e. the worker is a
1273     shared worker).</p>
1274    
1275     <p>A worker is said to be an <dfn id=active-needed-worker>active needed worker</dfn> if any
1276     of the <code>Document</code> objects in <a href="#the-worker's-documents">the worker's
1277     <code>Document</code>s</a> are <span>fully active</span>.</p>
1278    
1279     <p>A worker is said to be a <dfn id=suspendable-worker>suspendable worker</dfn> if it is
1280     not an <a href=#active-needed-worker>active needed worker</a> but it is a
1281     <a href=#permissible-worker>permissible worker</a>.</p>
1282    
1283    
1284 wakaba 1.172 <h3 id=processing-model><span class=secno>4.5 </span>Processing model</h3>
1285 wakaba 1.82
1286     <p>When a user agent is to <dfn id=run-a-worker>run a worker</dfn> for a script with
1287 wakaba 1.162 <span>URL</span> <var title="">url</var>, a browsing context <var title="">owner browsing context</var>, an origin <var title="">owner
1288     origin</var>, and with global scope <var title="">worker global
1289     scope</var>, it must run the following steps:</p>
1290 wakaba 1.82
1291 wakaba 1.130 <ol><li>
1292 wakaba 1.82
1293     <p>Create a completely separate and parallel execution environment
1294     (i.e. a separate thread or process or equivalent construct), and
1295     run the rest of these steps asynchronously in that context.</p>
1296    
1297     </li>
1298    
1299     <li><p>If <var title="">worker global scope</var> is actually a
1300     <code><a href=#sharedworkerglobalscope>SharedWorkerGlobalScope</a></code> object (i.e. the worker is a
1301     shared worker), and there are any <span title="relevant application
1302     cache">relevant application caches</span> that are identified by a
1303     manifest URL with the <span>same origin</span> as <var title="">url</var> and that have <var title="">url</var> as one of
1304     their entries, <em>not</em> excluding entries marked as <span title=concept-appcache-foreign>foreign</span>, then associate the
1305     <var title="">worker global scope</var> with the <span title=concept-appcache-selection>most appropriate application
1306     cache</span> of those that match.</li>
1307    
1308     <li>
1309    
1310 wakaba 1.162 <p>Attempt to <span>fetch</span> the resource identified by <var title="">url</var>, from the <var title="">owner origin</var>.</p>
1311     <!-- not http-origin privacy sensitive -->
1312 wakaba 1.82
1313 wakaba 1.83 <p>If the attempt fails, or if the attempt involves any redirects
1314     to URIs that do not have the <span>same origin</span> as <var title="">url</var> (even if the final URI is at the <span>same
1315     origin</span> as the original <var title="">url</var>), then for
1316     each <code><a href=#worker>Worker</a></code> or <code><a href=#sharedworker>SharedWorker</a></code> object
1317     associated with <var title="">worker global scope</var>,
1318     <span>queue a task</span> to <span>fire a simple event</span>
1319 wakaba 1.166 named <code title=event-error>error</code> at that
1320 wakaba 1.83 object. Abort these steps.</p>
1321 wakaba 1.82
1322 wakaba 1.172 <p>If the attempt succeeds, then convert the script resource to
1323     Unicode by assuming it was encoded as UTF-8, to obtain its <var title="">source</var>.</p>
1324 wakaba 1.82
1325     <p>Let <var title="">language</var> be JavaScript.</p>
1326    
1327     <p class=note>As with <code>script</code> elements, the MIME
1328     type of the script is ignored. Unlike with <code>script</code>
1329     elements, there is no way to override the type. It's always
1330 wakaba 1.154 assumed to be JavaScript.</p>
1331 wakaba 1.82
1332     </li>
1333    
1334     <li>
1335    
1336     <p>A new <span title=concept-script>script</span> is now
1337     created, as follows.</p>
1338    
1339     <p>Create a new <span>script execution environment</span>
1340     set up as appropriate for the scripting language <var title="">language</var>.</p>
1341    
1342     <p>Parse/compile/initialize <var title="">source</var> using that
1343     <span>script execution environment</span>, as appropriate for <var title="">language</var>, and thus obtain a <span>list of code
1344     entry-points</span>; set the <i>initial code entry-point</i> to
1345     the entry-point for any executable code to be immediately run.</p>
1346    
1347     <p>Set the <span>script's global object</span> to <var title="">worker global scope</var>.</p>
1348    
1349     <p>Set the <span>script's browsing context</span> to <var title="">owner browsing context</var>.</p>
1350    
1351     <p>Set the <span>script's URL character encoding</span> to
1352     UTF-8. (This is just used for encoding non-ASCII characters in the
1353     query component of URLs.)</p>
1354    
1355     <p>Set the <span>script's base URL</span> to <var title="">url</var>.</p>
1356    
1357     </li>
1358    
1359     <li>
1360    
1361     <p><strong>Closing orphan workers</strong>: Start monitoring the
1362     worker such that no sooner than it stops being either a
1363     <a href=#protected-worker>protected worker</a> or a <a href=#suspendable-worker>suspendable
1364     worker</a>, and no later than it stops being a
1365     <a href=#permissible-worker>permissible worker</a>, <var title="">worker global
1366     scope</var>'s <a href=#dom-workerglobalscope-closing title=dom-WorkerGlobalScope-closing>closing</a> flag is set
1367     to true<!-- v2-onclose and <span title="queue a task">a task is
1368 wakaba 1.166 queued</span> to <span>fire a simple event</span> named <code
1369 wakaba 1.82 title="event-close">close</code> at <var title="">worker global
1370     scope</var>-->.</p>
1371    
1372     </li>
1373    
1374     <li>
1375    
1376     <p><strong>Suspending workers</strong>: Start monitoring the
1377     worker, such that whenever <var title="">worker global
1378     scope</var>'s <a href=#dom-workerglobalscope-closing title=dom-WorkerGlobalScope-closing>closing</a> flag is false
1379     and the worker is a <a href=#suspendable-worker>suspendable worker</a>, the user
1380     agent suspends execution of script in that worker until such time
1381     as either the <a href=#dom-workerglobalscope-closing title=dom-WorkerGlobalScope-closing>closing</a> flag switches
1382     to true or the worker stops being a <a href=#suspendable-worker>suspendable
1383     worker</a>.</p>
1384    
1385     </li>
1386    
1387     <li>
1388    
1389     <p><span title="jump to a code entry-point">Jump</span> to the
1390     <span title=concept-script>script</span>'s <i>initial code
1391     entry-point</i>, and let that run until it either returns, fails
1392     to catch an exception, or gets prematurely aborted by the
1393     "<a href=#kill-a-worker>kill a worker</a>" or "<a href=#terminate-a-worker>terminate a worker</a>"
1394     algorithms defined below.</p>
1395    
1396 wakaba 1.122 <!-- v2-onclose
1397     <p class="note">If the script gets aborted by the "<span>kill a
1398     worker</span>" algorithm, then that same algorithm will cause
1399     there to only be a single <span title="concept-task">task</span>
1400 wakaba 1.82 in the <span>event loop</span> at the next step, namely the task
1401 wakaba 1.122 for the <code title="message-close">close</code> event. The
1402     "<span>terminate a worker</span>" algorithm removes all the
1403 wakaba 1.82 events.</p>
1404 wakaba 1.122 -->
1405 wakaba 1.82
1406     </li>
1407    
1408     <li><p>If <var title="">worker global scope</var> is actually a
1409     <code><a href=#dedicatedworkerglobalscope>DedicatedWorkerGlobalScope</a></code> object (i.e. the worker is
1410     a dedicated worker), then enable the <span>port message
1411     queue</span> of the worker's implicit port.</li>
1412    
1413     <li>
1414    
1415     <p><i title="">Event loop</i>: Wait until either there is a <span title=concept-task>task</span> in one of the <span>event
1416     loop</span>'s <span title="task queue">task queues</span> or <var title="">worker global scope</var>'s <a href=#dom-workerglobalscope-closing title=dom-WorkerGlobalScope-closing>closing</a> flag is set
1417     to true.</p>
1418    
1419     </li>
1420    
1421     <li>
1422    
1423     <p>Run the oldest task on one of the <span>event loop</span>'s
1424     <span title="task queue">task queues</span>, if any. The user
1425     agent may pick any <span>task queue</span>.</p>
1426    
1427     <p class=note>The handling of events or the execution of
1428     callbacks might get prematurely aborted by the "<a href=#kill-a-worker>kill a
1429     worker</a>" or "<a href=#terminate-a-worker>terminate a worker</a>" algorithms
1430     defined below.</p>
1431    
1432     </li>
1433    
1434     <li>
1435    
1436     <p>Remove the task run in the previous step, if any, from its
1437     <span>task queue</span>.</p>
1438    
1439     </li>
1440    
1441     <li>
1442    
1443     <p>If there are any more events in the <span>event loop</span>'s
1444     <span title="task queue">task queues</span> or if <var title="">worker global scope</var>'s <a href=#dom-workerglobalscope-closing title=dom-WorkerGlobalScope-closing>closing</a> flag is set
1445     to false, then jump back to the step above labeled <i>event
1446     loop</i>.</p>
1447    
1448     </li>
1449    
1450     <li>
1451    
1452     <p>If there are any outstanding transactions that have callbacks
1453     that involve <span title=concept-script>scripts</span> whose
1454     <span title="script's global object">global object</span> is the
1455     <var title="">worker global scope</var>, roll them back (without
1456     invoking any of the callbacks).</p>
1457    
1458     </li>
1459    
1460     <li>
1461    
1462     <p>Empty the <var title="">worker global scope</var>'s <span>list
1463     of active timeouts</span> and its <span>list of active
1464     intervals</span>.</p>
1465    
1466     </li>
1467    
1468     <!-- v2-onclose
1469     <li>
1470    
1471     <p>For each <code>Worker</code> or <code>SharedWorker</code>
1472     object associated with <var title="">worker global scope</var>,
1473     <span>queue a task</span> to <span>fire a simple event</span>
1474 wakaba 1.166 named <code title="event-close">close</code> at that object.</p>
1475 wakaba 1.82
1476     </li>
1477     -->
1478 wakaba 1.130 </ol><hr><p>When a user agent is to <dfn id=kill-a-worker>kill a worker</dfn> it must
1479 wakaba 1.82 run the following steps in parallel with the worker's main loop (the
1480     "<a href=#run-a-worker>run a worker</a>" processing model defined above):</p>
1481    
1482 wakaba 1.130 <ol><!-- v2-onclose
1483 wakaba 1.82 <li><p>If the worker's <code>WorkerGlobalScope</code> object's
1484     <span title="dom-WorkerGlobalScope-closing">closing</span> flag is
1485     false, <span>queue a task</span> to <span>fire a simple
1486 wakaba 1.166 event</span> named <code title="event-close">close</code> at the
1487 wakaba 1.82 worker's <code>WorkerGlobalScope</code> object.</p></li>
1488 wakaba 1.130 --><li><p>Set the worker's <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object's <a href=#dom-workerglobalscope-closing title=dom-WorkerGlobalScope-closing>closing</a> flag to
1489 wakaba 1.82 true.</li>
1490    
1491     <!-- v2-onclose
1492     <li><p>Wait a user-agent-defined amount of time. If the "<span>run
1493     a worker</span>" processing model defined above immediately starts
1494     running event listeners registered for the <code
1495     title="event-close">close</code> event, this time should not be
1496     zero &mdash; the idea is that the <code
1497     title="event-close">close</code> event can be used to clean up
1498     when shutting down unexpectedly.</p></li>
1499     -->
1500    
1501     <li><p>If there are any <span title=concept-task>tasks</span>
1502     queued in the <span>event loop</span>'s <span title="task
1503     queue">task queues</span><!-- v2-onclose other than the <code
1504     title="event-close">close</code> event that this algorithm just
1505     added-->, discard them without processing them.</li>
1506    
1507     <!-- v2-onclose
1508     <li><p>If the <code title="event-close">close</code> event that
1509     this algorithm just queued hasn't yet been dispatched, then abort
1510     the script currently running in the worker.</p></li>
1511     -->
1512    
1513     <li><p>Wait a user-agent-defined amount of time.</li>
1514    
1515     <li><p>Abort the script currently running in the worker<!--
1516     v2-onclose (if any script is running, then it will be a handler for
1517     the <code title="event-close">close</code> event)-->.</li>
1518    
1519 wakaba 1.130 </ol><p>User agents may invoke the "<a href=#kill-a-worker>kill a worker</a>"
1520 wakaba 1.82 processing model on a worker at any time, e.g. in response to user
1521     requests, in response to CPU quota management, or when a worker
1522     stops being an <a href=#active-needed-worker>active needed worker</a> if the worker
1523     continues executing even after its <a href=#dom-workerglobalscope-closing title=dom-WorkerGlobalScope-closing>closing</a> flag was
1524     set to true.</p>
1525    
1526 wakaba 1.130 <hr><p>When a user agent is to <dfn id=terminate-a-worker>terminate a worker</dfn> it must run
1527 wakaba 1.82 the following steps in parallel with the worker's main loop (the
1528     "<a href=#run-a-worker>run a worker</a>" processing model defined above):</p>
1529    
1530 wakaba 1.130 <ol><li><p>Set the worker's <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object's
1531 wakaba 1.82 <a href=#dom-workerglobalscope-closing title=dom-WorkerGlobalScope-closing>closing</a> flag to
1532     true.</li>
1533    
1534     <li><p>If there are any <span title=concept-task>tasks</span>
1535     queued in the <span>event loop</span>'s <span title="task
1536     queue">task queues</span>, discard them without processing
1537     them.</li>
1538    
1539     <li><p>Abort the script currently running in the worker.</li>
1540    
1541     <li><p>If the worker's <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object is
1542     actually a <code><a href=#dedicatedworkerglobalscope>DedicatedWorkerGlobalScope</a></code> object (i.e. the
1543     worker is a dedicated worker), then empty the <span>port message
1544     queue</span> of the port that the worker's implicit port is
1545     entangled with.</li>
1546    
1547 wakaba 1.130 </ol><hr><p>The <span>task source</span> for the tasks mentioned above is the
1548 wakaba 1.104 <span>DOM manipulation task source</span>.</p>
1549    
1550    
1551 wakaba 1.172 <h3 id=runtime-script-errors><span class=secno>4.6 </span>Runtime script errors</h3>
1552 wakaba 1.82
1553 wakaba 1.108 <p>Whenever an uncaught runtime script error occurs in one of the
1554     worker's scripts, if the error did not occur while handling a
1555     previous script error, the user agent must <span>report the
1556     error</span> using the <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object's <code title=handler-WorkerGlobalScope-onerror><a href=#handler-workerglobalscope-onerror>onerror</a></code>
1557     attribute. <a href=#refsHTML5>[HTML5]</a></p>
1558 wakaba 1.82
1559     <p>For shared workers, if the error is still <i title=concept-error-nothandled>not handled</i> afterwards, or if
1560 wakaba 1.91 the error occurred while handling a previous script error, the error
1561 wakaba 1.108 should be reported to the user. <a href=#refsHTML5>[HTML5]</a></p>
1562 wakaba 1.82
1563     <p>For dedicated workers, if the error is still <i title=concept-error-nothandled>not handled</i> afterwards, or if
1564 wakaba 1.91 the error occurred while handling a previous script error, the user
1565 wakaba 1.82 agent must <span>queue a task</span> to <a href=#fire-a-worker-error-event>fire a worker error
1566     event</a> at the <code><a href=#worker>Worker</a></code> object associated with the
1567     worker.</p>
1568    
1569     <p>When the user agent is to <dfn id=fire-a-worker-error-event>fire a worker error event</dfn> at
1570     a <code><a href=#worker>Worker</a></code> object, it must dispatch an event that uses
1571     the <code><a href=#errorevent>ErrorEvent</a></code> interface, with the name <code title=event-error>error</code>, that doesn't bubble and is
1572     cancelable, with its <code title=dom-ErrorEvent-message><a href=#dom-errorevent-message>message</a></code>, <code title=dom-ErrorEvent-filename><a href=#dom-errorevent-filename>filename</a></code>, and <code title=dom-ErrorEvent-lineno><a href=#dom-errorevent-lineno>lineno</a></code> attributes set
1573     appropriately. The default action of this event depends on whether
1574     the <code><a href=#worker>Worker</a></code> object is itself in a worker. If it is, and
1575     that worker is also a dedicated worker, then the user agent must
1576     again <span>queue a task</span> to <a href=#fire-a-worker-error-event>fire a worker error
1577     event</a> at the <code><a href=#worker>Worker</a></code> object associated with
1578     <em>that</em> worker. Otherwise, then the error should be reported
1579     to the user.</p>
1580    
1581 wakaba 1.104 <p>The <span>task source</span> for the tasks mentioned above is the
1582     <span>DOM manipulation task source</span>.</p>
1583    
1584 wakaba 1.130 <hr><pre class=idl>interface <dfn id=errorevent>ErrorEvent</dfn> : Event {
1585 wakaba 1.109 readonly attribute DOMString <a href=#dom-errorevent-message title=dom-ErrorEvent-message>message</a>;
1586     readonly attribute DOMString <a href=#dom-errorevent-filename title=dom-ErrorEvent-filename>filename</a>;
1587 wakaba 1.82 readonly attribute unsigned long <a href=#dom-errorevent-lineno title=dom-ErrorEvent-lineno>lineno</a>;
1588 wakaba 1.109 void <a href=#dom-errorevent-initerrorevent title=dom-ErrorEvent-initErrorEvent>initErrorEvent</a>(in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in DOMString messageArg, in DOMString filenameArg, in unsigned long linenoArg);
1589     void <a href=#dom-errorevent-initerroreventns title=dom-ErrorEvent-initErrorEventNS>initErrorEventNS</a>(in DOMString namespaceURIArg, in DOMString typeArg, in boolean canBubbleArg, in boolean cancelableArg, in DOMString messageArg, in DOMString filenameArg, in unsigned long linenoArg);
1590 wakaba 1.82 };</pre>
1591    
1592     <p>The <dfn id=dom-errorevent-initerrorevent title=dom-ErrorEvent-initErrorEvent><code>initErrorEvent()</code></dfn>
1593     and <dfn id=dom-errorevent-initerroreventns title=dom-ErrorEvent-initErrorEventNS><code>initErrorEventNS()</code></dfn>
1594     methods must initialize the event in a manner analogous to the
1595 wakaba 1.126 similarly-named methods in the DOM Events interfaces. <a href=#refsDOMEVENTS>[DOMEVENTS]</a></p>
1596 wakaba 1.82
1597     <p>The <dfn id=dom-errorevent-message title=dom-ErrorEvent-message><code>message</code></dfn>
1598     attribute represents the error message.</p>
1599    
1600     <p>The <dfn id=dom-errorevent-filename title=dom-ErrorEvent-filename><code>filename</code></dfn>
1601     attribute represents the <span>absolute URL</span> of the script in
1602 wakaba 1.91 which the error originally occurred.</p>
1603 wakaba 1.82
1604     <p>The <dfn id=dom-errorevent-lineno title=dom-ErrorEvent-lineno><code>lineno</code></dfn>
1605 wakaba 1.91 attribute represents the line number where the error occurred in the
1606 wakaba 1.82 script.</p>
1607    
1608    
1609    
1610 wakaba 1.172 <h3 id=creating-workers><span class=secno>4.7 </span>Creating workers</h3>
1611 wakaba 1.82
1612 wakaba 1.172 <h4 id=the-abstractworker-abstract-interface><span class=secno>4.7.1 </span>The <code><a href=#abstractworker>AbstractWorker</a></code> abstract interface</h4>
1613 wakaba 1.82
1614     <pre class=idl>interface <dfn id=abstractworker>AbstractWorker</dfn> {
1615 wakaba 1.108 attribute <span>Function</span> <a href=#handler-abstractworker-onerror title=handler-AbstractWorker-onerror>onerror</a>;
1616     <!-- v2-onclose attribute <span>Function</span> <span title="handler-AbstractWorker-onclose">onclose</span>; -->
1617 wakaba 1.155 };
1618     <a href=#abstractworker>AbstractWorker</a> implements <span>EventTarget</span>;</pre>
1619 wakaba 1.82
1620 wakaba 1.162 <p>The following are the <span>event handlers</span> (and their
1621     corresponding <span title="event handler event type">event handler
1622     event types</span>) that must be supported, as IDL attributes, by
1623     objects implementing the <code><a href=#abstractworker>AbstractWorker</a></code> interface:</p>
1624 wakaba 1.82
1625 wakaba 1.162 <table><thead><tr><th><span title="event handlers">Event handler</span> <th><span>Event handler event type</span>
1626 wakaba 1.130 <tbody><tr><td><dfn id=handler-abstractworker-onerror title=handler-AbstractWorker-onerror><code>onerror</code></dfn> <td> <code title=event-error>error</code>
1627 wakaba 1.82 <!-- v2-onclose <tr><td><dfn title="handler-AbstractWorker-onclose"><code>onclose</code></dfn> <td> <code title="event-close">close</code> -->
1628 wakaba 1.172 </table><h4 id=dedicated-workers-and-the-worker-interface><span class=secno>4.7.2 </span>Dedicated workers and the <code><a href=#worker>Worker</a></code> interface</h4>
1629 wakaba 1.82
1630     <pre class=idl>[<a href=#dom-worker title=dom-Worker>Constructor</a>(in DOMString scriptURL)]
1631     interface <dfn id=worker>Worker</dfn> : <a href=#abstractworker>AbstractWorker</a> {
1632     void <a href=#dom-worker-terminate title=dom-Worker-terminate>terminate</a>();
1633    
1634 wakaba 1.159 void <a href=#dom-worker-postmessage title=dom-Worker-postMessage>postMessage</a>(in any message, in optional <span>MessagePortArray</span> ports);<!--
1635 wakaba 1.82 <span>MessagePort</span> <span title="dom-Worker-startConversation">startConversation</span>(in any message);-->
1636 wakaba 1.108 attribute <span>Function</span> <a href=#handler-worker-onmessage title=handler-Worker-onmessage>onmessage</a>;
1637 wakaba 1.82 };</pre>
1638    
1639     <p>The <dfn id=dom-worker-terminate title=dom-Worker-terminate><code>terminate()</code></dfn> method,
1640     when invoked, must cause the "<a href=#terminate-a-worker>terminate a worker</a>"
1641     algorithm to be run on the worker with with the object is
1642     associated.</p>
1643    
1644     <p><code><a href=#worker>Worker</a></code> objects act as if they had an implicit
1645     <code>MessagePort</code> associated with them. This port is part of
1646     a channel that is set up when the worker is created, but it is not
1647     exposed. This object must never be garbage collected before the
1648     <code><a href=#worker>Worker</a></code> object.</p>
1649    
1650     <p>All messages received by that port must immediately be retargeted
1651     at the <code><a href=#worker>Worker</a></code> object.</p>
1652    
1653     <p>The <dfn id=dom-worker-postmessage title=dom-Worker-postMessage><code>postMessage()</code></dfn><!--
1654     and <dfn
1655     title="dom-Worker-startConversation"><code>startConversation()</code></dfn>-->
1656     method<!--s (startConversation)--> on <code><a href=#worker>Worker</a></code> objects
1657     must act as if, when invoked, it<!--/they (startConversation)-->
1658     immediately invoked the method of the same name on the port, with
1659     the same arguments, and returned the same return value.</p>
1660    
1661 wakaba 1.162 <p>The following are the <span>event handlers</span> (and their
1662     corresponding <span title="event handler event type">event handler
1663     event types</span>) that must be supported, as IDL attributes, by
1664     objects implementing the <code><a href=#worker>Worker</a></code> interface:</p>
1665 wakaba 1.82
1666 wakaba 1.162 <table><thead><tr><th><span title="event handlers">Event handler</span> <th><span>Event handler event type</span>
1667 wakaba 1.130 <tbody><tr><td><dfn id=handler-worker-onmessage title=handler-Worker-onmessage><code>onmessage</code></dfn> <td> <code title=event-message>message</code>
1668     </table><hr><p>When the <dfn id=dom-worker title=dom-Worker><code>Worker(<var title="">scriptURL</var>)</code></dfn> constructor is invoked, the
1669 wakaba 1.82 user agent must run the following steps:</p>
1670    
1671 wakaba 1.130 <ol><li><p><span title="resolve a url">Resolve</span> the <var title="">scriptURL</var> argument relative to the <span>first
1672 wakaba 1.92 script</span>'s <span title="script's base URL">base URL</span>,
1673     when the method is invoked.</li>
1674 wakaba 1.82
1675     <li><p>If this fails, throw a <code>SYNTAX_ERR</code>
1676     exception.</li>
1677    
1678 wakaba 1.152 <li>
1679    
1680     <p>If the <span>origin</span> of the resulting <span>absolute
1681     URL</span> is not the <span title="same origin">same</span> as the
1682 wakaba 1.162 origin of the <span>first script</span>, then throw a
1683 wakaba 1.172 <code>SECURITY_ERR</code> exception.</p>
1684 wakaba 1.152
1685     <p class=note>Thus, scripts must be external files with the same
1686     scheme as the original page: you can't load a script from a <code title="">data:</code> URL or <code title="">javascript:</code>
1687     URL, and a <code>https:</code> page couldn't start workers using
1688     scripts with <code>http:</code> URLs.</p>
1689    
1690     </li>
1691 wakaba 1.82
1692 wakaba 1.172 <li><p>Create a new <code><a href=#dedicatedworkerglobalscope>DedicatedWorkerGlobalScope</a></code>
1693     object. Let <var title="">worker global scope</var> be this new
1694     object.</li>
1695 wakaba 1.82
1696     <li><p>Create a new <code><a href=#worker>Worker</a></code> object, associated with
1697     <var title="">worker global scope</var>. Let <var title="">worker</var> be this new object.</li>
1698    
1699 wakaba 1.172 <li><p><span>Create a new <code>MessagePort</code> object</span>
1700     owned by the <span title="script's global scope">global
1701     scope</span> of the <span title=concept-script>script</span> that
1702     invoked the constructor. Let this be the <var title="">outside
1703 wakaba 1.82 port</var>.</li>
1704    
1705     <li><p>Associate the <var title="">outside port</var> with <var title="">worker</var>.</li>
1706    
1707 wakaba 1.172 <li><p><span>Create a new <code>MessagePort</code> object</span>
1708     owned by <var title="">worker global scope</var>. Let <var title="">inside port</var> be this new object.</li>
1709 wakaba 1.82
1710     <li><p>Associate <var title="">inside port</var> with <var title="">worker global scope</var>.</li>
1711    
1712     <li><p><span>Entangle</span> <var title="">outside port</var> and
1713     <var title="">inside port</var>.</li>
1714    
1715     <li><p>Return <var title="">worker</var>, and run the following
1716     steps asynchronously.</li>
1717    
1718     <li><p>Enable <var title="">inside port</var>'s <span>port message
1719     queue</span>.</li>
1720    
1721     <li><p>Enable <var title="">outside port</var>'s <span>port message
1722     queue</span>.</li>
1723    
1724     <li>
1725    
1726     <p>Let <var title="">docs</var> be the <a href=#list-of-relevant-document-objects-to-add>list of relevant
1727     <code>Document</code> objects to add</a> given the <span title="script's global scope">global scope</span> of the <span title=concept-script>script</span> that invoked the
1728     constructor.</p>
1729    
1730     </li>
1731    
1732     <li>
1733    
1734     <p><a href="#add-a-document-to-the-worker's-documents" title="add a document to the worker's documents">Add to
1735     <var title="">worker global scope</var>'s list of <span>the
1736     worker's <code>Document</code>s</span></a> the
1737     <code>Document</code> objects in <var title="">docs</var>.</p>
1738    
1739     </li>
1740    
1741     <li>
1742    
1743     <p>If the <span title="script's global scope">global scope</span>
1744     of the <span title=concept-script>script</span> that invoked the
1745     constructor is a <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object (i.e. we
1746     are creating a nested worker), add <var title="">worker global
1747     scope</var> to the list of <a href="#the-worker's-workers">the worker's workers</a> of the
1748     <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object that is the <span title="script's global scope">global scope</span> of the <span title=concept-script>script</span> that invoked the
1749     constructor.</p>
1750    
1751     </li>
1752    
1753     <li>
1754    
1755     <p><a href=#run-a-worker>Run a worker</a> for the resulting <span>absolute
1756     URL</span>, with the <span>script browsing context</span> of the
1757     script that invoked the method as the <var title="">owner browsing
1758 wakaba 1.162 context</var>, with the <span>origin</span> of the <span>first
1759     script</span> as the <var title="">owner origin</var>, and with
1760     <var title="">worker global scope</var> as the global scope.</p>
1761 wakaba 1.82
1762     </li>
1763    
1764 wakaba 1.130 </ol><p>This constructor must be visible when the <span>script's global
1765 wakaba 1.95 scope</span> is either a <code>Window</code> object or an object
1766     implementing the <code><a href=#workerutils>WorkerUtils</a></code> interface.</p>
1767    
1768    
1769 wakaba 1.172 <h4 id=shared-workers-and-the-sharedworker-interface><span class=secno>4.7.3 </span>Shared workers and the <code><a href=#sharedworker>SharedWorker</a></code> interface</h4>
1770 wakaba 1.82
1771 wakaba 1.159 <pre class=idl>[<a href=#dom-sharedworker title=dom-SharedWorker>Constructor</a>(in DOMString scriptURL, in optional DOMString name)]
1772 wakaba 1.82 interface <dfn id=sharedworker>SharedWorker</dfn> : <a href=#abstractworker>AbstractWorker</a> {
1773     readonly attribute <span>MessagePort</span> <a href=#dom-sharedworker-port title=dom-SharedWorker-port>port</a>;
1774     };</pre>
1775    
1776     <p>The <dfn id=dom-sharedworker-port title=dom-SharedWorker-port><code>port</code></dfn>
1777     attribute must return the value it was assigned by the object's
1778     constructor. It represents the <code>MessagePort</code> for
1779     communicating with the shared worker.</p>
1780    
1781     <p>When the <dfn id=dom-sharedworker title=dom-SharedWorker><code>SharedWorker(<var title="">scriptURL</var>, <var title="">name</var>)</code></dfn>
1782     constructor is invoked, the user agent must run the following
1783     steps:</p>
1784    
1785 wakaba 1.130 <ol><li><p><span title="resolve a url">Resolve</span> the <var title="">scriptURL</var> argument.</li>
1786 wakaba 1.82
1787     <li><p>If this fails, throw a <code>SYNTAX_ERR</code>
1788     exception.</li>
1789    
1790 wakaba 1.139 <li><p>Otherwise, let <var title="">scriptURL</var> be the
1791     resulting <span>absolute URL</span>.</li>
1792    
1793     <li><p>Let <var title="">name</var> be the value of the second
1794 wakaba 1.144 argument, or the empty string if the second argument was
1795     omitted.</li>
1796 wakaba 1.139
1797 wakaba 1.152 <li>
1798    
1799     <p>If the <span>origin</span> of <var title="">scriptURL</var> is
1800     not the <span title="same origin">same</span> as the origin of the
1801 wakaba 1.172 <span>first script</span>, then throw a <code>SECURITY_ERR</code>
1802     exception.</p>
1803 wakaba 1.152
1804     <p class=note>Thus, scripts must be external files with the same
1805     scheme as the original page: you can't load a script from a <code title="">data:</code> URL or <code title="">javascript:</code>
1806     URL, and a <code>https:</code> page couldn't start workers using
1807     scripts with <code>http:</code> URLs.</p>
1808    
1809     </li>
1810 wakaba 1.82
1811     <li>
1812    
1813     <p>Let <var title="">docs</var> be the <a href=#list-of-relevant-document-objects-to-add>list of relevant
1814     <code>Document</code> objects to add</a> given the <span title="script's global scope">global scope</span> of the <span title=concept-script>script</span> that invoked the
1815     constructor.</p>
1816    
1817     </li>
1818    
1819     <li>
1820    
1821     <p>Execute the following substeps atomically:</p>
1822    
1823 wakaba 1.130 <ol><li><p>Create a new <code><a href=#sharedworker>SharedWorker</a></code> object, which will
1824 wakaba 1.82 shortly be associated with a <code><a href=#sharedworkerglobalscope>SharedWorkerGlobalScope</a></code>
1825     object. Let this <code><a href=#sharedworker>SharedWorker</a></code> object be <var title="">worker</var>.</li>
1826    
1827 wakaba 1.172 <li><p><span>Create a new <code>MessagePort</code> object</span>
1828 wakaba 1.82 owned by the <span title="script's global scope">global
1829     scope</span> of the script that invoked the method. Let this be
1830     the <var title="">outside port</var>.</li>
1831    
1832     <li><p>Assign <var title="">outside port</var> to the <code title=dom-SharedWorker-port><a href=#dom-sharedworker-port>port</a></code> attribute of <var title="">worker</var>.</li>
1833    
1834 wakaba 1.144 <li><p>Let <var title="">worker global scope</var> be
1835     null.</li>
1836    
1837     <li><p>If <var title="">name</var> is not the empty string and
1838     there exists a <code><a href=#sharedworkerglobalscope>SharedWorkerGlobalScope</a></code> object whose
1839     <a href=#dom-workerglobalscope-closing title=dom-WorkerGlobalScope-closing>closing</a> flag
1840     is false, whose <code title=dom-WorkerGlobalScope-name>name</code> attribute is
1841     exactly equal to <var title="">name</var>, and whose <code title=dom-WorkerGlobalScope-location><a href=#dom-workerglobalscope-location>location</a></code> attribute
1842     represents an <span>absolute URL</span> with the <span>same
1843     origin</span> as <var title="">scriptURL</var>, then let <var title="">worker global scope</var> be that
1844     <code><a href=#sharedworkerglobalscope>SharedWorkerGlobalScope</a></code> object.</li>
1845    
1846     <li><p>Otherwise, if <var title="">name</var> is the empty string
1847     and there exists a <code><a href=#sharedworkerglobalscope>SharedWorkerGlobalScope</a></code> object
1848     whose <a href=#dom-workerglobalscope-closing title=dom-WorkerGlobalScope-closing>closing</a>
1849     flag is false, and whose <code title=dom-WorkerGlobalScope-location><a href=#dom-workerglobalscope-location>location</a></code> attribute
1850     is exactly equal to <var title="">scriptURL</var>, then let <var title="">worker global scope</var> be that
1851     <code><a href=#sharedworkerglobalscope>SharedWorkerGlobalScope</a></code> object.</li>
1852    
1853 wakaba 1.82 <li>
1854    
1855 wakaba 1.144 <p>If <var title="">worker global scope</var> is not null, then
1856     run these steps:</p>
1857 wakaba 1.82
1858 wakaba 1.144 <ol><li><p>If <var title="">worker global scope</var>'s <code title=dom-WorkerGlobalScope-location><a href=#dom-workerglobalscope-location>location</a></code>
1859 wakaba 1.82 attribute represents an <span>absolute URL</span> that is not
1860 wakaba 1.139 exactly equal to <var title="">scriptURL</var>, then throw a
1861     <code>URL_MISMATCH_ERR</code> exception and abort all these
1862     steps.</li>
1863 wakaba 1.82
1864     <li><p>Associate <var title="">worker</var> with <var title="">worker global scope</var>.</li>
1865    
1866 wakaba 1.172 <li><p><span>Create a new <code>MessagePort</code>
1867     object</span> owned by <var title="">worker global
1868     scope</var>. Let this be the <var title="">inside
1869     port</var>.</li>
1870 wakaba 1.82
1871     <li><p><span>Entangle</span> <var title="">outside port</var>
1872     and <var title="">inside port</var>.</li>
1873    
1874     <li><p>Return <var title="">worker</var> and perform the next
1875     step asynchronously.</li>
1876    
1877     <li><p>Create an event that uses the <code>MessageEvent</code>
1878     interface, with the name <code title=event-connect>connect</code>, which does not bubble, is
1879     not cancelable, has no default action, has a <code title=dom-MessageEvent-data>data</code> attribute whose value
1880     is the empty string and has a <code title=dom-MessageEvent-ports>ports</code> attribute whose
1881     value is an array containing only the newly created port, and
1882     <span>queue a task</span> to dispatch the event at <var title="">worker global scope</var>.</li>
1883    
1884     <li>
1885    
1886     <p><a href="#add-a-document-to-the-worker's-documents" title="add a document to the worker's documents">Add to
1887     <var title="">worker global scope</var>'s list of <span>the
1888     worker's <code>Document</code>s</span></a> the
1889     <code>Document</code> objects in <var title="">docs</var>.</p>
1890    
1891     </li>
1892    
1893     <li>
1894    
1895     <p>If the <span title="script's global scope">global
1896     scope</span> of the <span title=concept-script>script</span>
1897     that invoked the constructor is a
1898     <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object, add <var title="">worker global scope</var> to the list of <a href="#the-worker's-workers">the
1899     worker's workers</a> of the <code><a href=#workerglobalscope>WorkerGlobalScope</a></code>
1900     object that is the <span title="script's global scope">global
1901     scope</span> of the <span title=concept-script>script</span>
1902     that invoked the constructor.</p>
1903    
1904     </li>
1905    
1906     <li><p>Abort all these steps.</li>
1907    
1908 wakaba 1.130 </ol></li>
1909 wakaba 1.82
1910 wakaba 1.172 <li><p>Create a new <code><a href=#sharedworkerglobalscope>SharedWorkerGlobalScope</a></code>
1911     object. Let <var title="">worker global scope</var> be this new
1912     object.</li>
1913 wakaba 1.82
1914     <li><p>Associate <var title="">worker</var> with <var title="">worker global scope</var>.</li>
1915    
1916     <li><p>Set the <code title=dom-SharedWorkerGlobalScope-name><a href=#dom-sharedworkerglobalscope-name>name</a></code> attribute of
1917     <var title="">worker global scope</var> to <var title="">name</var>.</li>
1918    
1919 wakaba 1.172 <li><p><span>Create a new <code>MessagePort</code> object</span>
1920 wakaba 1.82 owned by <var title="">worker global scope</var>. Let <var title="">inside port</var> be this new object.</li>
1921    
1922     <li><p><span>Entangle</span> <var title="">outside port</var> and
1923     <var title="">inside port</var>.</li>
1924    
1925 wakaba 1.130 </ol></li>
1926 wakaba 1.82
1927     <li><p>Return <var title="">worker</var> and perform the remaining
1928     steps asynchronously.</li>
1929    
1930     <li><p>Create an event that uses the <code>MessageEvent</code>
1931     interface, with the name <code title=event-connect>connect</code>, which does not bubble, is not
1932     cancelable, has no default action, has a <code title=dom-MessageEvent-data>data</code> attribute whose value is
1933     the empty string and has a <code title=dom-MessageEvent-ports>ports</code> attribute whose value
1934     is an array containing only the newly created port, and <span>queue
1935     a task</span> to dispatch the event at <var title="">worker global
1936     scope</var>.</li>
1937    
1938     <li>
1939    
1940     <p><a href="#add-a-document-to-the-worker's-documents" title="add a document to the worker's documents">Add to
1941     <var title="">worker global scope</var>'s list of <span>the
1942     worker's <code>Document</code>s</span></a> the
1943     <code>Document</code> objects in <var title="">docs</var>.</p>
1944    
1945     </li>
1946    
1947     <li>
1948    
1949     <p>If the <span title="script's global scope">global scope</span>
1950     of the <span title=concept-script>script</span> that invoked the
1951     constructor is a <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object, add <var title="">worker global scope</var> to the list of <a href="#the-worker's-workers">the
1952     worker's workers</a> of the <code><a href=#workerglobalscope>WorkerGlobalScope</a></code>
1953     object that is the <span title="script's global scope">global
1954     scope</span> of the <span title=concept-script>script</span>
1955     that invoked the constructor.</p>
1956    
1957     </li>
1958    
1959     <li>
1960    
1961 wakaba 1.139 <p><a href=#run-a-worker>Run a worker</a> for <var title="">scriptURL</var>,
1962     with the <span>script browsing context</span> of the script that
1963     invoked the method as the <var title="">owner browsing
1964 wakaba 1.162 context</var>, with the <span>origin</span> of the <span>first
1965     script</span> as the <var title="">owner origin</var>, and with
1966     <var title="">worker global scope</var> as the global scope.</p>
1967 wakaba 1.82
1968     </li>
1969    
1970 wakaba 1.130 </ol><p>This constructor must be visible when the <span>script's global
1971 wakaba 1.95 scope</span> is either a <code>Window</code> object or an object
1972     implementing the <code><a href=#workerutils>WorkerUtils</a></code> interface.</p>
1973 wakaba 1.104
1974     <p>The <span>task source</span> for the tasks mentioned above is the
1975     <span>DOM manipulation task source</span>.</p>
1976 wakaba 1.95
1977    
1978    
1979 wakaba 1.110 <h2 id=apis-available-to-workers><span class=secno>5 </span>APIs available to workers</h2>
1980 wakaba 1.82
1981 wakaba 1.125 <pre class=idl>[Supplemental, NoInterfaceObject]
1982     interface <dfn id=workerutils>WorkerUtils</dfn> {
1983     void <a href=#dom-workerglobalscope-importscripts title=dom-WorkerGlobalScope-importScripts>importScripts</a>(in DOMString... urls);
1984 wakaba 1.82 readonly attribute <a href=#worker-navigator title=worker-Navigator>Navigator</a> <a href=#dom-worker-navigator title=dom-worker-navigator>navigator</a>;
1985 wakaba 1.125 };
1986 wakaba 1.172 <a href=#workerutils>WorkerUtils</a> implements <span>WindowTimers</span>;</pre>
1987 wakaba 1.82
1988 wakaba 1.155 <p>The DOM APIs (<code>Node</code> objects, <code>Document</code>
1989 wakaba 1.82 objects, etc) are not available to workers in this version of this
1990     specification.</p>
1991    
1992    
1993 wakaba 1.110 <h3 id=importing-scripts-and-libraries><span class=secno>5.1 </span>Importing scripts and libraries</h3>
1994 wakaba 1.82
1995     <p>When a script invokes the <dfn id=dom-workerglobalscope-importscripts title=dom-WorkerGlobalScope-importScripts><code>importScripts(<var title="">urls</var>)</code></dfn> method on a
1996     <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object, the user agent must run the
1997     following steps:</p>
1998    
1999 wakaba 1.130 <ol><li><p>If there are no arguments, return without doing
2000 wakaba 1.82 anything. Abort these steps.</li>
2001    
2002     <li><p><span title="resolve a url">Resolve</span> each
2003     argument.</li>
2004    
2005     <li><p>If any fail, throw a <code>SYNTAX_ERR</code>
2006     exception.</li>
2007    
2008     <!--
2009     <li><p>If any of the resulting <span title="absolute URL">absolute
2010     URLs</span> have an <span>origin</span> that is not the <span
2011     title="same origin">same</span> as the origin of the script that
2012 wakaba 1.172 invoked the method, then throw a <code>SECURITY_ERR</code>
2013     exception.</p></li>
2014 wakaba 1.82 -->
2015    
2016     <li>
2017    
2018     <p>Attempt to <span>fetch</span> each resource identified by the
2019 wakaba 1.162 resulting <span title="absolute URLs">absolute URL</span>, from
2020     the <span>first script</span>'s <span>origin</span>.</p> <!-- not
2021     http-origin privacy sensitive -->
2022 wakaba 1.82
2023     </li>
2024    
2025     <li>
2026    
2027     <p>For each argument in turn, in the order given, starting with
2028     the first one, run these substeps:</p>
2029    
2030 wakaba 1.130 <ol><li>
2031 wakaba 1.82
2032     <p>Wait for the fetching attempt for the corresponding resource
2033     to complete.</p>
2034    
2035     <p>If the fetching attempt failed, throw a
2036     <code>NETWORK_ERR</code> exception and abort all these
2037     steps.</p>
2038    
2039 wakaba 1.172 <p>If the attempt succeeds, then convert the script resource to
2040     Unicode by assuming it was encoded as UTF-8, to obtain its <var title="">source</var>.</p>
2041 wakaba 1.82
2042     <p>Let <var title="">language</var> be JavaScript.</p>
2043    
2044     <p class=note>As with the worker's script, the script here is
2045     always assumed to be JavaScript, regardless of the MIME
2046 wakaba 1.154 type.</p>
2047 wakaba 1.82
2048     </li>
2049    
2050     <li>
2051    
2052     <p><span>Create a script</span>, using <var title="">source</var> as the script source and <var title="">language</var> as the scripting language, using the
2053 wakaba 1.174 same global object, browsing context, URL character encoding,
2054     base URL, and script group as the <span title=concept-script>script</span> that was created by the
2055 wakaba 1.82 worker's <a href=#run-a-worker>run a worker</a> algorithm.</p>
2056    
2057     <p>Let the newly created <span title=concept-script>script</span> run until it either
2058     returns, fails to parse, fails to catch an exception, or gets
2059     prematurely aborted by the "<a href=#kill-a-worker>kill a worker</a>" or
2060     "<a href=#terminate-a-worker>terminate a worker</a>" algorithms defined above.</p>
2061    
2062 wakaba 1.154 <p>If it failed to parse, then throw a <code>SyntaxError</code>
2063     exception and abort all these steps.</p>
2064 wakaba 1.82
2065     <p>If an exception was raised or if the script was prematurely
2066     aborted, then abort all these steps, letting the exception or
2067     aborting continue to be processed by the script that called the
2068     <code title=dom-WorkerGlobalScope-importScripts><a href=#dom-workerglobalscope-importscripts>importScripts()</a></code>
2069     method.</p>
2070    
2071     <p>If the "<a href=#kill-a-worker>kill a worker</a>" or "<a href=#terminate-a-worker>terminate a
2072     worker</a>" algorithms abort the script then abort all these
2073     steps.</p>
2074    
2075     </li>
2076    
2077 wakaba 1.130 </ol></li>
2078 wakaba 1.82
2079 wakaba 1.130 </ol><h3 id=the-navigator-object><span class=secno>5.2 </span>The <code title=worker-Navigator><a href=#worker-navigator>Navigator</a></code> object</h3>
2080 wakaba 1.82
2081     <p>The <dfn id=dom-worker-navigator title=dom-worker-navigator><code>navigator</code></dfn> attribute
2082     of the <code><a href=#workerutils>WorkerUtils</a></code> interface must return an instance of
2083     the <code title=worker-Navigator><a href=#worker-navigator>Navigator</a></code> interface, which
2084     represents the identity and state of the user agent (the
2085     client):</p>
2086    
2087 wakaba 1.125 <pre class=idl>interface <dfn id=worker-navigator title=worker-Navigator>Navigator</dfn> {};
2088     <a href=#worker-navigator title=worker-Navigator>Navigator</a> implements <span>NavigatorID</span>;
2089     <a href=#worker-navigator title=worker-Navigator>Navigator</a> implements <span>NavigatorOnLine</span>;</pre>
2090    
2091     <p>Objects implementing the <code title=worker-Navigator><a href=#worker-navigator>Navigator</a></code> interface also implement
2092     the <code>NavigatorID</code> and <code>NavigatorOnLine</code>
2093     interfaces. <a href=#refsHTML5>[HTML5]</a></p>
2094 wakaba 1.82
2095     <p class=note>The <code title=worker-Navigator><a href=#worker-navigator>Navigator</a></code>
2096     interface defined in this specification is different than the one
2097 wakaba 1.84 defined in the HTML specification.</p>
2098 wakaba 1.82
2099    
2100    
2101 wakaba 1.110 <h3 id=apis-defined-in-other-specifications><span class=secno>5.3 </span>APIs defined in other specifications</h3>
2102 wakaba 1.82
2103     <p>The <code title=dom-opendatabase>openDatabase()</code> and
2104     <code title=dom-opendatabase-sync>openDatabaseSync()</code>
2105 wakaba 1.108 methods are defined in the Web Database specification. <a href=#refsWEBDATABASE>[WEBDATABASE]</a></p>
2106 wakaba 1.82
2107    
2108    
2109 wakaba 1.110 <h3 id=interface-objects-and-constructors><span class=secno>5.4 </span>Interface objects and constructors</h3>
2110 wakaba 1.82
2111     <p>There must be no interface objects and constructors available in
2112     the global scope of scripts whose <span>script execution
2113     context</span> is a <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object except for
2114     the following:</p>
2115    
2116 wakaba 1.130 <ul><li><p><code>XMLHttpRequest</code> and all interface objects and
2117 wakaba 1.82 constructors defined by the XMLHttpRequest specifications, except
2118     that the <span>document response entity body</span> must always be
2119 wakaba 1.141 null. The <span><code>XMLHttpRequest</code> base URL</span> is the
2120     <span>script's base URL</span>; the
2121     <span><code>XMLHttpRequest</code> origin</span> is the script's
2122     <span>origin</span>. <a href=#refsXHR>[XHR]</a></li>
2123 wakaba 1.82
2124     <li><p>The <code>WebSocket</code> interface object and
2125     constructor. <a href=#refsWEBSOCKET>[WEBSOCKET]</a></li>
2126    
2127     <li><p>The <code>EventSource</code> interface object and
2128     constructor. <a href=#refsEVENTSOURCE>[EVENTSOURCE]</a></li>
2129    
2130     <li><p>The <code>MessageChannel</code> interface object and
2131     constructor. <a href=#refsHTML5>[HTML5]</a></li>
2132    
2133 wakaba 1.172 <li><p>The <code title=dom-Worker><a href=#dom-worker>Worker</a></code> and <code title=dom-SharedWorker><a href=#dom-sharedworker>SharedWorker</a></code> interface objects and
2134     constructors.</li>
2135 wakaba 1.82
2136 wakaba 1.130 </ul><h3 id=worker-locations><span class=secno>5.5 </span>Worker locations</h3>
2137 wakaba 1.82
2138     <pre class=idl>interface <dfn id=workerlocation>WorkerLocation</dfn> {
2139     readonly attribute DOMString <a href=#dom-workerlocation-href title=dom-WorkerLocation-href>href</a>;
2140     readonly attribute DOMString <a href=#dom-workerlocation-protocol title=dom-WorkerLocation-protocol>protocol</a>;
2141     readonly attribute DOMString <a href=#dom-workerlocation-host title=dom-WorkerLocation-host>host</a>;
2142     readonly attribute DOMString <a href=#dom-workerlocation-hostname title=dom-WorkerLocation-hostname>hostname</a>;
2143     readonly attribute DOMString <a href=#dom-workerlocation-port title=dom-WorkerLocation-port>port</a>;
2144     readonly attribute DOMString <a href=#dom-workerlocation-pathname title=dom-WorkerLocation-pathname>pathname</a>;
2145     readonly attribute DOMString <a href=#dom-workerlocation-search title=dom-WorkerLocation-search>search</a>;
2146     readonly attribute DOMString <a href=#dom-workerlocation-hash title=dom-WorkerLocation-hash>hash</a>;
2147     };</pre>
2148    
2149     <p>A <code><a href=#workerlocation>WorkerLocation</a></code> object represents an <span>absolute
2150     URL</span> set at its creation.</p>
2151    
2152     <p>The <dfn id=dom-workerlocation-href title=dom-WorkerLocation-href><code>href</code></dfn>
2153     attribute must return the <span>absolute URL</span> that the object
2154     represents.</p>
2155    
2156     <p>The <code><a href=#workerlocation>WorkerLocation</a></code> interface also has the complement
2157 wakaba 1.143 of <span>URL decomposition IDL attributes</span>, <dfn id=dom-workerlocation-protocol title=dom-WorkerLocation-protocol><code>protocol</code></dfn>,
2158 wakaba 1.82 <dfn id=dom-workerlocation-host title=dom-WorkerLocation-host><code>host</code></dfn>, <dfn id=dom-workerlocation-port title=dom-WorkerLocation-port><code>port</code></dfn>, <dfn id=dom-workerlocation-hostname title=dom-WorkerLocation-hostname><code>hostname</code></dfn>,
2159     <dfn id=dom-workerlocation-pathname title=dom-WorkerLocation-pathname><code>pathname</code></dfn>,
2160     <dfn id=dom-workerlocation-search title=dom-WorkerLocation-search><code>search</code></dfn>,
2161     and <dfn id=dom-workerlocation-hash title=dom-WorkerLocation-hash><code>hash</code></dfn>. These must
2162 wakaba 1.143 follow the rules given for URL decomposition IDL attributes, with the
2163 wakaba 1.82 <span title=concept-uda-input>input</span> being the
2164     <span>absolute URL</span> that the object represents (same as the
2165     <code title=dom-WorkerLocation-href><a href=#dom-workerlocation-href>href</a></code> attribute), and
2166     the <span title=concept-uda-setter>common setter action</span>
2167     being a no-op, since the attributes are defined to be readonly. <a href=#refsHTML5>[HTML5]</a></p>
2168 wakaba 1.147
2169 wakaba 1.166 <!--START vCard--><!--START vEvent-->
2170 wakaba 1.82
2171 wakaba 1.134 <h2 class=no-num id=references>References</h2><!--REFS-->
2172 wakaba 1.82
2173 wakaba 1.166 <!--END vCard--><!--END vEvent-->
2174 wakaba 1.128 <p>All references are normative unless marked "Non-normative".</p>
2175 wakaba 1.166 <!--START vCard--><!--START vEvent-->
2176 wakaba 1.128
2177 wakaba 1.130 <dl><dt id=refsDOMCORE>[DOMCORE]</dt>
2178 wakaba 1.129 <dd><cite><a href=http://www.w3.org/TR/DOM-Level-3-Core/>Document
2179     Object Model (DOM) Level 3 Core Specification</a></cite>, A. Le
2180     Hors, P. Le Hegaret, L. Wood, G. Nicol, J. Robie, M. Champion,
2181     S. Byrnes. W3C, April 2004.</dd>
2182     <!--
2183     <dd><cite><a href="http://simon.html5.org/specs/web-dom-core">Web
2184     DOM Core</a></cite>, S. Pieters. W3C, June 2009.</dd>
2185     -->
2186    
2187 wakaba 1.128 <dt id=refsDOMEVENTS>[DOMEVENTS]</dt>
2188     <!--
2189     <dd><cite><a
2190     href="http://www.w3.org/TR/DOM-Level-3-Events/">Document Object
2191     Model (DOM) Level 3 Events Specification</a></cite>,
2192     B. H&ouml;hrmann, P. Le Hegaret, T. Pixley. W3C, December
2193     2007.</dd>
2194     -->
2195     <dd><cite><a href=http://dev.w3.org/2006/webapi/DOM-Level-3-Events/html/DOM3-Events.html>Document
2196     Object Model (DOM) Level 3 Events Specification</a></cite>,
2197     D. Schepers. W3C, July 2009.</dd>
2198    
2199     <dt id=refsECMA262>[ECMA262]</dt>
2200     <dd><cite><a href=http://www.ecma-international.org/publications/standards/Ecma-262.htm>ECMAScript
2201     Language Specification</a></cite>. ECMA, December 1999.</dd>
2202    
2203     <dt id=refsEVENTSOURCE>[EVENTSOURCE]</dt>
2204     <!--
2205     <dd><cite><a href="http://www.w3.org/TR/eventsource/">Server-Sent
2206     Events</a></cite>, I. Hickson. W3C, April 2009.</dd>
2207     -->
2208     <dd><cite><a href=http://dev.w3.org/html5/eventsource/>Server-Sent
2209     Events</a></cite>, I. Hickson. W3C, July 2009.</dd>
2210    
2211     <dt id=refsHTML5>[HTML5]</dt>
2212     <!--
2213 wakaba 1.142 <dd><cite><a href="http://www.w3.org/TR/html5/">HTML5</a></cite>,
2214 wakaba 1.128 I. Hickson, D. Hyatt. W3C, April 2009.</dd>
2215 wakaba 1.142 <dd><cite><a
2216     href="http://www.w3.org/html/wg/html5/">HTML5</a></cite>,
2217     I. Hickson, D. Hyatt. W3C, August 2009.</dd>
2218 wakaba 1.128 -->
2219 wakaba 1.142 <dd><cite><a href=http://www.whatwg.org/specs/web-apps/current-work/>HTML5</a></cite>,
2220     I. Hickson. WHATWG, August 2009.</dd>
2221 wakaba 1.128
2222 wakaba 1.129 <dt id=refsRFC2119>[RFC2119]</dt>
2223     <dd><cite><a href=http://www.ietf.org/rfc/rfc2119.txt>Key words for use in
2224     RFCs to Indicate Requirement Levels</a></cite>, S. Bradner. IETF, March
2225     1997.</dd>
2226    
2227 wakaba 1.128 <dt id=refsWEBDATABASE>[WEBDATABASE]</dt>
2228     <dd><cite><a href=http://dev.w3.org/html5/webdatabase/>Web
2229     Database</a></cite>, I. Hickson. W3C, July
2230     2009.</dd>
2231 wakaba 1.129
2232     <dt id=refsWEBIDL>[WEBIDL]</dt>
2233     <!--
2234     <dd><cite><a href="http://www.w3.org/TR/WebIDL/">Web
2235     IDL</a></cite>, C. McCormack. W3C, December 2008.</dd>
2236     -->
2237     <dd><cite><a href=http://dev.w3.org/2006/webapi/WebIDL/>Web
2238     IDL</a></cite>, C. McCormack. W3C, July 2009.</dd>
2239 wakaba 1.128
2240     <dt id=refsWEBSOCKET>[WEBSOCKET]</dt>
2241     <!--
2242     <dd><cite><a href="http://www.w3.org/TR/websockets/">The Web Sockets
2243     API</a></cite>, I. Hickson. W3C, April
2244     2009.</dd>
2245     -->
2246     <dd><cite><a href=http://dev.w3.org/html5/websockets/>The Web Sockets
2247     API</a></cite>, I. Hickson. W3C, August
2248     2009.</dd>
2249    
2250     <dt id=refsXHR>[XHR]</dt>
2251     <!--
2252     <dd><cite><a href="http://www.w3.org/TR/XMLHttpRequest/">The XMLHttpRequest
2253     Object</a></cite>, A. van Kesteren. W3C, April
2254     2008.</dd>
2255     -->
2256 wakaba 1.141 <dd><cite><a href=http://dev.w3.org/2006/webapi/XMLHttpRequest-2/><code>XMLHttpRequest</code></a></cite>,
2257 wakaba 1.128 A. van Kesteren. W3C, June 2009.</dd>
2258    
2259 wakaba 1.166 </dl><!--END vCard--><!--END vEvent--><h2 class=no-num id=acknowledgements>Acknowledgements</h2> <!-- ACKS -->
2260 wakaba 1.82
2261     <p>Thanks to
2262    
2263     Aaron Boodman,
2264 wakaba 1.130 &#1040;&#1083;&#1077;&#1082;&#1089;&#1077;&#1081; &#1055;&#1088;&#1086;&#1089;&#1082;&#1091;&#1088;&#1103;&#1082;&#1086;&#1074; (Alexey Proskuryakov),
2265 wakaba 1.82 Anne van Kesteren,
2266     Ben Turner,
2267     Dmitry Titov,
2268     Drew Wilson,
2269     Jeremy Orlow,
2270     Jonas Sicking,
2271     Justin James,
2272     Kevin Hakanson,
2273     Maciej Stachowiak,
2274     Michael Nordman,
2275     Mike Smith,
2276    
2277     and
2278    
2279     Philip Taylor
2280    
2281     for their useful and substantial comments.</p>
2282    
2283     <p>Huge thanks to the whole Gears team, who pioneered this
2284     technology and whose experience has been a huge influence on this
2285     specification.</p>
2286    
2287    

admin@suikawiki.org
ViewVC Help
Powered by ViewVC 1.1.24