/[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.41 - (hide annotations) (download) (as text)
Wed Apr 15 06:19:39 2009 UTC (16 years, 11 months ago) by wakaba
Branch: MAIN
Changes since 1.40: +1 -1 lines
File MIME type: text/html
make

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

admin@suikawiki.org
ViewVC Help
Powered by ViewVC 1.1.24