| 1 |
wakaba |
1.82 |
<!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 |
|
|
<div class=head> |
| 3 |
|
|
<p><a class=logo href=http://www.whatwg.org/ rel=home><img alt=WHATWG src=/images/logo></a></p> |
| 4 |
|
|
<h1>Web Workers</h1> |
| 5 |
wakaba |
1.103 |
<h2 class="no-num no-toc" id=draft-recommendation-—-date:-01-jan-1901>Draft Recommendation — 8 July 2009</h2> |
| 6 |
wakaba |
1.82 |
<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>© 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 |
|
|
</div> |
| 25 |
|
|
|
| 26 |
|
|
<hr><h2 class="no-num no-toc" id=abstract>Abstract</h2> |
| 27 |
|
|
|
| 28 |
|
|
<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 |
|
|
|
| 33 |
|
|
|
| 34 |
|
|
<h2 class="no-num no-toc" id=status>Status of this document</h2> |
| 35 |
|
|
|
| 36 |
|
|
<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 |
|
|
|
| 55 |
|
|
<h2 class="no-num no-toc" id=contents>Table of contents</h2> |
| 56 |
|
|
|
| 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-lifetime"><span class=secno>4.5 </span>The worker's lifetime</a></li> |
| 85 |
|
|
<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 |
|
|
<ol> |
| 89 |
|
|
<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 |
|
|
<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 |
|
|
<li><a href=#the-navigator-object><span class=secno>5.2 </span>The <code title=worker-Navigator>Navigator</code> object</a></li> |
| 96 |
|
|
<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 |
|
|
|
| 104 |
|
|
<h3 id=scope><span class=secno>1.1 </span>Scope</h3> |
| 105 |
|
|
|
| 106 |
|
|
<p><em>This section is non-normative.</em></p> |
| 107 |
|
|
|
| 108 |
|
|
<p>This specification defines an API for running scripts in the |
| 109 |
|
|
background independently of any user interface scripts.</p> |
| 110 |
|
|
|
| 111 |
|
|
<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 |
|
|
|
| 122 |
|
|
<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 |
|
|
|
| 125 |
|
|
|
| 126 |
|
|
<h3 id=tutorial><span class=secno>1.2 </span>Tutorial</h3> |
| 127 |
|
|
|
| 128 |
|
|
<p><em>This section is non-normative.</em></p> |
| 129 |
|
|
|
| 130 |
|
|
<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 |
|
|
|
| 133 |
|
|
<h4 id=a-background-number-crunching-worker><span class=secno>1.2.1 </span>A background number-crunching worker</h4> |
| 134 |
|
|
|
| 135 |
|
|
<p><em>This section is non-normative.</em></p> |
| 136 |
|
|
|
| 137 |
|
|
<p>The simplest use of workers is for performing a computationally |
| 138 |
|
|
expensive task without interrupting the user interface.</p> |
| 139 |
|
|
|
| 140 |
|
|
<p>In this example, the main document spawns a worker to |
| 141 |
|
|
(naï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><!DOCTYPE HTML> |
| 147 |
|
|
<html> |
| 148 |
|
|
<head> |
| 149 |
|
|
<title>Worker example: One-core computation</title> |
| 150 |
|
|
</head> |
| 151 |
|
|
<body> |
| 152 |
|
|
<p>The highest prime number discovered so far is: <output id="result"></output></p> |
| 153 |
|
|
<script> |
| 154 |
|
|
var worker = new Worker('worker.js'); |
| 155 |
|
|
worker.onmessage = function (event) { |
| 156 |
|
|
document.getElementById('result').textContent = event.data; |
| 157 |
|
|
}; |
| 158 |
|
|
</script> |
| 159 |
|
|
</body> |
| 160 |
|
|
</html></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 |
|
|
|
| 168 |
|
|
<p>The worker itself is as follows:</p> |
| 169 |
|
|
|
| 170 |
|
|
<pre>var n = 1; |
| 171 |
|
|
search: while (true) { |
| 172 |
|
|
n += 1; |
| 173 |
|
|
for (var i = 2; i <= Math.sqrt(n); i += 1) |
| 174 |
|
|
if (n % i == 0) |
| 175 |
|
|
continue search; |
| 176 |
|
|
// found a prime! |
| 177 |
|
|
postMessage(n); |
| 178 |
|
|
}</pre> |
| 179 |
|
|
|
| 180 |
|
|
<p>The bulk of this code is simply an unoptimized search for a prime |
| 181 |
|
|
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 |
|
|
|
| 186 |
|
|
|
| 187 |
|
|
|
| 188 |
|
|
<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 |
|
|
|
| 190 |
|
|
<p><em>This section is non-normative.</em></p> |
| 191 |
|
|
|
| 192 |
|
|
<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 |
|
|
|
| 197 |
|
|
<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><script> |
| 201 |
|
|
new Worker('worker.js'); |
| 202 |
|
|
</script></pre> |
| 203 |
|
|
|
| 204 |
|
|
<p>The worker itself is as follows:</p> |
| 205 |
|
|
|
| 206 |
|
|
<pre>var server = new WebSocket('ws://whatwg.org/database'); |
| 207 |
|
|
var database = openDatabase('demobase', '1.0', 'Demo Database', 10240); |
| 208 |
|
|
server.onmessage = function (event) { |
| 209 |
|
|
// data is in the format "command key value" |
| 210 |
|
|
var data = event.data.split(' '); |
| 211 |
|
|
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 |
|
|
<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><!DOCTYPE HTML> |
| 247 |
|
|
<html> |
| 248 |
|
|
<head> |
| 249 |
|
|
<title>Worker example: Stock ticker</title> |
| 250 |
|
|
<script> |
| 251 |
|
|
// TICKER |
| 252 |
|
|
var symbol = 'GOOG'; // default symbol to watch |
| 253 |
|
|
var ticker = new Worker('ticker.js'); |
| 254 |
|
|
|
| 255 |
|
|
// SEARCHER |
| 256 |
|
|
var searcher = new Worker('searcher.js'); |
| 257 |
|
|
function search(query) { |
| 258 |
|
|
searcher.postMessage(query); |
| 259 |
|
|
} |
| 260 |
|
|
|
| 261 |
|
|
// SYMBOL SELECTION UI |
| 262 |
|
|
function select(newSymbol) { |
| 263 |
|
|
symbol = newSymbol; |
| 264 |
|
|
ticker.postMessage(symbol); |
| 265 |
|
|
} |
| 266 |
|
|
</script> |
| 267 |
|
|
</head> |
| 268 |
|
|
<body onload="search('')"> |
| 269 |
|
|
<p><output id="symbol"></output> <output id="value"></output></p> |
| 270 |
|
|
<script> |
| 271 |
|
|
ticker.onmessage = function (event) { |
| 272 |
|
|
var data = event.data.split(' '); |
| 273 |
|
|
document.getElementById('symbol').textContent = data[0]; |
| 274 |
|
|
document.getElementById('value').textContent = data[1]; |
| 275 |
|
|
}; |
| 276 |
|
|
ticker.postMessage(symbol); |
| 277 |
|
|
</script> |
| 278 |
|
|
<p><label>Search: <input type="text" autofocus oninput="search(this.value)"></label></p> |
| 279 |
|
|
<ul id="results"></ul> |
| 280 |
|
|
<script> |
| 281 |
|
|
searcher.onmessage = function (event) { |
| 282 |
|
|
var data = event.data.split(' '); |
| 283 |
|
|
var results = document.getElementById('results'); |
| 284 |
|
|
while (results.hasChildNodes()) // clear previous results |
| 285 |
|
|
results.removeChild(results.firstChild); |
| 286 |
|
|
for (var i = 0; i < 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 |
|
|
</script> |
| 299 |
|
|
<p>(The data in this example is not real. Try searching for "Google" or "Apple".)</p> |
| 300 |
|
|
</body> |
| 301 |
|
|
</html></pre> |
| 302 |
|
|
|
| 303 |
|
|
<p>The two workers use a common library for performing the actual |
| 304 |
|
|
network calls. This library is as follows:</p> |
| 305 |
|
|
|
| 306 |
|
|
<pre>function get(url) { |
| 307 |
|
|
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 |
|
|
}</pre> |
| 316 |
|
|
|
| 317 |
|
|
<p>The stock updater worker is as follows:</p> |
| 318 |
|
|
|
| 319 |
|
|
<pre>importScripts('io.js'); |
| 320 |
|
|
var timer; |
| 321 |
|
|
var symbol; |
| 322 |
|
|
function update() { |
| 323 |
|
|
postMessage(symbol + ' ' + get('stock.cgi?' + symbol)); |
| 324 |
|
|
timer = setTimeout(update, 10000); |
| 325 |
|
|
} |
| 326 |
|
|
onmessage = function (event) { |
| 327 |
|
|
if (timer) |
| 328 |
|
|
clearTimeout(timer); |
| 329 |
|
|
symbol = event.data; |
| 330 |
|
|
update(); |
| 331 |
|
|
};</pre> |
| 332 |
|
|
|
| 333 |
|
|
<p>The search query worker is as follows:</p> |
| 334 |
|
|
|
| 335 |
|
|
<pre>importScripts('io.js'); |
| 336 |
|
|
onmessage = function (event) { |
| 337 |
|
|
postMessage(get('search.cgi?' + event.data)); |
| 338 |
|
|
};</pre> |
| 339 |
|
|
|
| 340 |
|
|
<p><a href=http://www.whatwg.org/demos/workers/stocks/page.html>View this example online</a>.</p> |
| 341 |
|
|
|
| 342 |
|
|
|
| 343 |
|
|
<h4 id=shared-workers><span class=secno>1.2.4 </span>Shared workers</h4> |
| 344 |
|
|
|
| 345 |
|
|
<p><em>This section is non-normative.</em></p> |
| 346 |
|
|
|
| 347 |
|
|
<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><!DOCTYPE HTML> |
| 357 |
|
|
<html> |
| 358 |
|
|
<head> |
| 359 |
|
|
<title>Workers example: Multiviewer</title> |
| 360 |
|
|
<script> |
| 361 |
|
|
function openViewer() { |
| 362 |
|
|
window.open('viewer.html'); |
| 363 |
|
|
} |
| 364 |
|
|
</script> |
| 365 |
|
|
</head> |
| 366 |
|
|
<body> |
| 367 |
|
|
<p><button type=button onclick="openViewer()">Open a new |
| 368 |
|
|
viewer</button></p> |
| 369 |
|
|
<p>Each viewer opens in a new window. You can have as many viewers |
| 370 |
|
|
as you like, they all view the same data.</p> |
| 371 |
|
|
</body> |
| 372 |
|
|
</html></pre> |
| 373 |
|
|
|
| 374 |
|
|
<p>The viewer is more involved:</p> |
| 375 |
|
|
|
| 376 |
|
|
<pre><!DOCTYPE HTML> |
| 377 |
|
|
<html> |
| 378 |
|
|
<head> |
| 379 |
|
|
<title>Workers example: Multiviewer viewer</title> |
| 380 |
|
|
<script> |
| 381 |
|
|
var worker = new SharedWorker('worker.js', 'core'); |
| 382 |
|
|
|
| 383 |
|
|
// CONFIGURATION |
| 384 |
|
|
function configure(event) { |
| 385 |
|
|
if (event.data.substr(0, 4) != 'cfg ') return; |
| 386 |
|
|
var name = event.data.substr(4).split(' ', 1); |
| 387 |
|
|
// update display to mention our name is name |
| 388 |
|
|
document.getElementsByTagName('h1')[0].textContent += ' ' + name; |
| 389 |
|
|
// no longer need this listener |
| 390 |
|
|
worker.port.removeEventListener('message', configure, false); |
| 391 |
|
|
} |
| 392 |
|
|
worker.port.addEventListener('message', configure, false); |
| 393 |
|
|
|
| 394 |
|
|
// MAP |
| 395 |
|
|
function paintMap(event) { |
| 396 |
|
|
if (event.data.substr(0, 4) != 'map ') return; |
| 397 |
|
|
var data = event.data.substr(4).split(','); |
| 398 |
|
|
// display tiles data[0] .. data[8] |
| 399 |
|
|
var canvas = document.getElementById('map'); |
| 400 |
|
|
var context = canvas.getContext('2d'); |
| 401 |
|
|
for (var y = 0; y < 3; y += 1) { |
| 402 |
|
|
for (var x = 0; x < 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 |
|
|
worker.port.addEventListener('message', paintMap, false); |
| 413 |
|
|
|
| 414 |
|
|
// PUBLIC CHAT |
| 415 |
|
|
function updatePublicChat(event) { |
| 416 |
|
|
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 |
|
|
// display "<name> message" in public chat |
| 420 |
|
|
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 |
|
|
worker.port.addEventListener('message', updatePublicChat, false); |
| 429 |
|
|
|
| 430 |
|
|
// PRIVATE CHAT |
| 431 |
|
|
function startPrivateChat(event) { |
| 432 |
|
|
if (event.data.substr(0, 4) != 'msg ') return; |
| 433 |
|
|
var name = event.data.substr(4).split(' ', 1); |
| 434 |
|
|
var port = event.ports[0]; |
| 435 |
|
|
// 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 |
|
|
addMessage(name, event.data); |
| 452 |
|
|
}; |
| 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 |
|
|
worker.port.addEventListener('message', startPrivateChat, false); |
| 473 |
|
|
</script> |
| 474 |
|
|
</head> |
| 475 |
|
|
<body> |
| 476 |
|
|
<h1>Viewer</h1> |
| 477 |
|
|
<h2>Map</h2> |
| 478 |
|
|
<p><canvas id="map" height=150 width=150></canvas></p> |
| 479 |
|
|
<p> |
| 480 |
|
|
<button type=button onclick="worker.port.postMessage('mov left')">Left</button> |
| 481 |
|
|
<button type=button onclick="worker.port.postMessage('mov up')">Up</button> |
| 482 |
|
|
<button type=button onclick="worker.port.postMessage('mov down')">Down</button> |
| 483 |
|
|
<button type=button onclick="worker.port.postMessage('mov right')">Right</button> |
| 484 |
|
|
<button type=button onclick="worker.port.postMessage('set 0')">Set 0</button> |
| 485 |
|
|
<button type=button onclick="worker.port.postMessage('set 1')">Set 1</button> |
| 486 |
|
|
</p> |
| 487 |
|
|
<h2>Public Chat</h2> |
| 488 |
|
|
<dialog id="public"></dialog> |
| 489 |
|
|
<form onsubmit="worker.port.postMessage('txt ' + message.value); message.value = ''; return false;"> |
| 490 |
|
|
<p> |
| 491 |
|
|
<input type="text" name="message" size="50"> |
| 492 |
|
|
<button>Post</button> |
| 493 |
|
|
</p> |
| 494 |
|
|
</form> |
| 495 |
|
|
<h2>Private Chat</h2> |
| 496 |
|
|
<ul id="private"></ul> |
| 497 |
|
|
</body> |
| 498 |
|
|
</html> |
| 499 |
|
|
</pre> |
| 500 |
|
|
|
| 501 |
|
|
<p>There are several key things worth noting about the way the |
| 502 |
|
|
viewer is written.</p> |
| 503 |
|
|
|
| 504 |
|
|
<p><strong>Multiple listeners</strong>. Instead of a single message |
| 505 |
|
|
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 |
|
|
|
| 518 |
|
|
<p>Finally, the worker:</p> |
| 519 |
|
|
|
| 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 < 0) return wrapX(x + map[0].length); |
| 540 |
|
|
if (x >= map[0].length) return wrapX(x - map[0].length); |
| 541 |
|
|
return x; |
| 542 |
|
|
} |
| 543 |
|
|
|
| 544 |
|
|
function wrapY(y) { |
| 545 |
|
|
if (y < 0) return wrapY(y + map.length); |
| 546 |
|
|
if (y >= map[0].length) return wrapY(y - map.length); |
| 547 |
|
|
return y; |
| 548 |
|
|
} |
| 549 |
|
|
|
| 550 |
|
|
function sendMapData(callback) { |
| 551 |
|
|
var data = ''; |
| 552 |
|
|
for (var y = viewer.y-1; y <= viewer.y+1; y += 1) { |
| 553 |
|
|
for (var x = viewer.x-1; x <= viewer.x+1; x += 1) { |
| 554 |
|
|
if (data != '') |
| 555 |
|
|
data += ','; |
| 556 |
|
|
data += map[y][x]; |
| 557 |
|
|
} |
| 558 |
|
|
} |
| 559 |
|
|
callback('map ' + data); |
| 560 |
|
|
} |
| 561 |
|
|
|
| 562 |
|
|
var viewers = {}; |
| 563 |
|
|
onconnect = function (event) { |
| 564 |
|
|
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 |
|
|
}; |
| 571 |
|
|
|
| 572 |
|
|
function getMessage(event) { |
| 573 |
|
|
switch (event.data.substr(0, 4)) { |
| 574 |
|
|
case 'mov ': |
| 575 |
|
|
var direction = event.data.substr(4); |
| 576 |
|
|
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 |
|
|
sendMapData(event.target.postMessage); |
| 587 |
|
|
break; |
| 588 |
|
|
case 'set ': |
| 589 |
|
|
var value = event.data.substr(4); |
| 590 |
|
|
map[event.target._data.y][event.target._data.x] = value; |
| 591 |
|
|
for (var viewer in viewers) |
| 592 |
|
|
sendMapData(viewers[viewer].port.postMessage); |
| 593 |
|
|
break; |
| 594 |
|
|
case 'txt ': |
| 595 |
|
|
var name = event.target._name; |
| 596 |
|
|
var message = event.data.substr(4); |
| 597 |
|
|
for (var viewer in viewers) |
| 598 |
|
|
viewers[viewer].port.postMessage('txt ' + name + ' ' + message); |
| 599 |
|
|
break; |
| 600 |
|
|
case 'msg ': |
| 601 |
|
|
var party1 = event._data; |
| 602 |
|
|
var party2 = viewers[event.data.substr(4).split(' ', 1)]; |
| 603 |
|
|
if (party2) { |
| 604 |
|
|
var channel = new MessageChannel(); |
| 605 |
|
|
party1.port.postMessage('msg ' + party2.name, [channel.port1]); |
| 606 |
|
|
party2.port.postMessage('msg ' + party1.name, [channel.port2]); |
| 607 |
|
|
} |
| 608 |
|
|
break; |
| 609 |
|
|
} |
| 610 |
|
|
}</pre> |
| 611 |
|
|
|
| 612 |
|
|
<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 |
|
|
|
| 624 |
|
|
|
| 625 |
|
|
<h4 id=delegation><span class=secno>1.2.5 </span>Delegation</h4> |
| 626 |
|
|
|
| 627 |
|
|
<p><em>This section is non-normative.</em></p> |
| 628 |
|
|
|
| 629 |
|
|
<p>With multicore CPUs becoming prevalent, one way to obtain better |
| 630 |
|
|
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><!DOCTYPE HTML> |
| 638 |
|
|
<html> |
| 639 |
|
|
<head> |
| 640 |
|
|
<title>Worker example: One-core computation</title> |
| 641 |
|
|
</head> |
| 642 |
|
|
<body> |
| 643 |
|
|
<p>The highest prime number discovered so far is: <output id="result"></output></p> |
| 644 |
|
|
<script> |
| 645 |
|
|
var worker = new Worker('worker.js'); |
| 646 |
|
|
worker.onmessage = function (event) { |
| 647 |
|
|
document.getElementById('result').textContent = event.data; |
| 648 |
|
|
}; |
| 649 |
|
|
</script> |
| 650 |
|
|
</body> |
| 651 |
|
|
</html></pre> |
| 652 |
|
|
|
| 653 |
|
|
<p>The worker itself is as follows:</p> |
| 654 |
|
|
|
| 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 < num_workers; i += 1) { |
| 663 |
|
|
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 |
|
|
} |
| 668 |
|
|
|
| 669 |
|
|
// handle the results |
| 670 |
|
|
function storeResult(event) { |
| 671 |
|
|
result += 1*event.data; |
| 672 |
|
|
pending_workers -= 1; |
| 673 |
|
|
if (pending_workers <= 0) |
| 674 |
|
|
postMessage(result); // finished! |
| 675 |
|
|
}</pre> |
| 676 |
|
|
|
| 677 |
|
|
<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 |
|
|
|
| 680 |
|
|
<p>The subworkers are implemented as follows:</p> |
| 681 |
|
|
|
| 682 |
|
|
<pre>var start; |
| 683 |
|
|
onmessage = getStart; |
| 684 |
|
|
function getStart(event) { |
| 685 |
|
|
start = 1*event.data; |
| 686 |
|
|
onmessage = getEnd; |
| 687 |
|
|
} |
| 688 |
|
|
|
| 689 |
|
|
var end; |
| 690 |
|
|
function getEnd(event) { |
| 691 |
|
|
end = 1*event.data; |
| 692 |
|
|
onmessage = null; |
| 693 |
|
|
work(); |
| 694 |
|
|
} |
| 695 |
|
|
|
| 696 |
|
|
function work() { |
| 697 |
|
|
var result = 0; |
| 698 |
|
|
for (var i = start; i < end; i += 1) { |
| 699 |
|
|
// perform some complex calculation here |
| 700 |
|
|
result += 1; |
| 701 |
|
|
} |
| 702 |
|
|
postMessage(result); |
| 703 |
|
|
close(); |
| 704 |
|
|
}</pre> |
| 705 |
|
|
|
| 706 |
|
|
<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 |
|
|
|
| 710 |
|
|
<p><a href=http://www.whatwg.org/demos/workers/multicore/page.html>View this example online</a>.</p> |
| 711 |
|
|
|
| 712 |
|
|
|
| 713 |
|
|
<h4 id=providing-libraries><span class=secno>1.2.6 </span>Providing libraries</h4> |
| 714 |
|
|
|
| 715 |
|
|
<p><em>This section is non-normative.</em></p> |
| 716 |
|
|
|
| 717 |
|
|
<p>Suppose that a cryptography library is made available that |
| 718 |
|
|
provides three tasks:</p> |
| 719 |
|
|
|
| 720 |
|
|
<dl><dt>Generate a public/private key pair</dt> |
| 721 |
|
|
|
| 722 |
|
|
<dd>Takes a port, on which it will send two messages, first the |
| 723 |
|
|
public key and then the private key.</dd> |
| 724 |
|
|
|
| 725 |
|
|
<dt>Given a plaintext and a public key, return the corresponding cyphertext</dt> |
| 726 |
|
|
|
| 727 |
|
|
<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 |
|
|
|
| 733 |
|
|
<dt>Given a cyphertext and a private key, return the corresponding plaintext</dt> |
| 734 |
|
|
|
| 735 |
|
|
<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 |
|
|
|
| 743 |
|
|
<pre>function handleMessage(e) { |
| 744 |
|
|
if (e.data == "genkeys") |
| 745 |
|
|
genkeys(e.ports[0]); |
| 746 |
|
|
else if (e.data == "encrypt") |
| 747 |
|
|
encrypt(e.ports[0]); |
| 748 |
|
|
else if (e.data == "decrypt") |
| 749 |
|
|
decrypt(e.ports[0]); |
| 750 |
|
|
} |
| 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 |
|
|
key = e.data; |
| 763 |
|
|
state = 1; |
| 764 |
|
|
} else { |
| 765 |
|
|
p.postMessage(_encrypt(key, e.data)); |
| 766 |
|
|
} |
| 767 |
|
|
}; |
| 768 |
|
|
} |
| 769 |
|
|
|
| 770 |
|
|
function decrypt(p) { |
| 771 |
|
|
var key, state = 0; |
| 772 |
|
|
p.onmessage = function (e) { |
| 773 |
|
|
if (state == 0) { |
| 774 |
|
|
key = e.data; |
| 775 |
|
|
state = 1; |
| 776 |
|
|
} else { |
| 777 |
|
|
p.postMessage(_decrypt(key, e.data)); |
| 778 |
|
|
} |
| 779 |
|
|
}; |
| 780 |
|
|
} |
| 781 |
|
|
|
| 782 |
|
|
// 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 |
|
|
|
| 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 |
|
|
<p>Note that the crypto functions here are just stubs and don't do |
| 804 |
|
|
real cryptography.</p> |
| 805 |
|
|
|
| 806 |
|
|
<p>This library could be used as follows:</p> |
| 807 |
|
|
|
| 808 |
|
|
<pre><!DOCTYPE HTML> |
| 809 |
|
|
<html> |
| 810 |
|
|
<head> |
| 811 |
|
|
<title>Worker example: Crypto library</title> |
| 812 |
|
|
<script> |
| 813 |
|
|
var crytoLib = new Worker('libcrypto-v1.js'); // or could use 'libcrypto-v2.js' |
| 814 |
|
|
function getKeys() { |
| 815 |
|
|
var state = 0; |
| 816 |
|
|
cryptoLib.startConversation("genkeys").onmessage = function (e) { |
| 817 |
|
|
if (state == 0) |
| 818 |
|
|
document.getElementById('public').value = e.data; |
| 819 |
|
|
else if (state == 1) |
| 820 |
|
|
document.getElementById('private').value = e.data; |
| 821 |
|
|
state += 1; |
| 822 |
|
|
}; |
| 823 |
|
|
} |
| 824 |
|
|
function enc() { |
| 825 |
|
|
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 |
|
|
document.getElementById('input').value = e.data; |
| 830 |
|
|
port.close(); |
| 831 |
|
|
}; |
| 832 |
|
|
} |
| 833 |
|
|
function dec() { |
| 834 |
|
|
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 |
|
|
document.getElementById('input').value = e.data; |
| 839 |
|
|
port.close(); |
| 840 |
|
|
}; |
| 841 |
|
|
} |
| 842 |
|
|
</script> |
| 843 |
|
|
<style> |
| 844 |
|
|
textarea { display: block; } |
| 845 |
|
|
</style> |
| 846 |
|
|
</head> |
| 847 |
|
|
<body onload="getKeys()"> |
| 848 |
|
|
<fieldset> |
| 849 |
|
|
<legend>Keys</legend> |
| 850 |
|
|
<p><label>Public Key: <textarea id="public"></textarea></label></p> |
| 851 |
|
|
<p><label>Private Key: <textarea id="private"></textarea></label></p> |
| 852 |
|
|
</fieldset> |
| 853 |
|
|
<p><label>Input: <textarea id="input"></textarea></label></p> |
| 854 |
|
|
<p><button onclick="enc()">Encrypt</button> <button onclick="dec()">Decrypt</button></p> |
| 855 |
|
|
</body> |
| 856 |
|
|
</html></pre> |
| 857 |
|
|
|
| 858 |
|
|
<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 |
|
|
|
| 861 |
|
|
<pre>function handleMessage(e) { |
| 862 |
|
|
if (e.data == "genkeys") |
| 863 |
|
|
genkeys(e.ports[0]); |
| 864 |
|
|
else if (e.data == "encrypt") |
| 865 |
|
|
encrypt(e.ports[0]); |
| 866 |
|
|
else if (e.data == "decrypt") |
| 867 |
|
|
decrypt(e.ports[0]); |
| 868 |
|
|
} |
| 869 |
|
|
|
| 870 |
|
|
function genkeys(p) { |
| 871 |
|
|
var generator = new Worker('libcrypto-v2-generator.js'); |
| 872 |
|
|
generator.postMessage('', [p]); |
| 873 |
|
|
} |
| 874 |
|
|
|
| 875 |
|
|
function encrypt(p) { |
| 876 |
|
|
p.onmessage = function (e) { |
| 877 |
|
|
var key = e.data; |
| 878 |
|
|
var encryptor = new Worker('libcrypto-v2-encryptor.js'); |
| 879 |
|
|
encryptor.postMessage(key, [p]); |
| 880 |
|
|
}; |
| 881 |
|
|
} |
| 882 |
|
|
|
| 883 |
|
|
function encrypt(p) { |
| 884 |
|
|
p.onmessage = function (e) { |
| 885 |
|
|
var key = e.data; |
| 886 |
|
|
var decryptor = new Worker('libcrypto-v2-decryptor.js'); |
| 887 |
|
|
decryptor.postMessage(key, [p]); |
| 888 |
|
|
}; |
| 889 |
|
|
} |
| 890 |
|
|
|
| 891 |
|
|
// 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 |
|
|
onconnect = function (e) { e.ports[0].onmessage = handleMessage }; |
| 896 |
|
|
</pre> |
| 897 |
|
|
|
| 898 |
|
|
<p>The little subworkers would then be as follows.</p> |
| 899 |
|
|
|
| 900 |
|
|
<p>For generating key pairs:</p> |
| 901 |
|
|
|
| 902 |
|
|
<pre>onmessage = function (e) { |
| 903 |
|
|
var k = _generateKeyPair(); |
| 904 |
|
|
e.ports[0].postMessage(k[0]); |
| 905 |
|
|
e.ports[0].postMessage(k[1]); |
| 906 |
|
|
close(); |
| 907 |
|
|
} |
| 908 |
|
|
|
| 909 |
|
|
function _generateKeyPair() { |
| 910 |
|
|
return [Math.random(), Math.random()]; |
| 911 |
|
|
}</pre> |
| 912 |
|
|
|
| 913 |
|
|
<p>For encrypting:</p> |
| 914 |
|
|
|
| 915 |
|
|
<pre>onmessage = function (e) { |
| 916 |
|
|
var key = e.data; |
| 917 |
|
|
e.ports[0].onmessage = function (e) { |
| 918 |
|
|
var s = e.data; |
| 919 |
|
|
postMessage(_encrypt(key, s)); |
| 920 |
|
|
} |
| 921 |
|
|
} |
| 922 |
|
|
|
| 923 |
|
|
function _encrypt(k, s) { |
| 924 |
|
|
return 'encrypted-' + k + ' ' + s; |
| 925 |
|
|
}</pre> |
| 926 |
|
|
|
| 927 |
|
|
<p>For decrypting:</p> |
| 928 |
|
|
|
| 929 |
|
|
<pre>onmessage = function (e) { |
| 930 |
|
|
var key = e.data; |
| 931 |
|
|
e.ports[0].onmessage = function (e) { |
| 932 |
|
|
var s = e.data; |
| 933 |
|
|
postMessage(_decrypt(key, s)); |
| 934 |
|
|
} |
| 935 |
|
|
} |
| 936 |
|
|
|
| 937 |
|
|
function _decrypt(k, s) { |
| 938 |
|
|
return s.substr(s.indexOf(' ')+1); |
| 939 |
|
|
}</pre> |
| 940 |
|
|
|
| 941 |
|
|
<p>Notice how the users of the API don't have to even know that this |
| 942 |
|
|
is happening — the API hasn't changed; the library can |
| 943 |
|
|
delegate to subworkers without changing its API, even though it is |
| 944 |
|
|
accepting data using message channels.</p> |
| 945 |
|
|
|
| 946 |
|
|
<p><a href=http://www.whatwg.org/demos/workers/crypto/page.html>View this example online</a>.</p> |
| 947 |
|
|
|
| 948 |
|
|
|
| 949 |
|
|
|
| 950 |
|
|
|
| 951 |
|
|
<h2 id=conformance-requirements><span class=secno>2 </span>Conformance requirements</h2> |
| 952 |
|
|
|
| 953 |
|
|
<p>All diagrams, examples, and notes in this specification are |
| 954 |
|
|
non-normative, as are all sections explicitly marked non-normative. |
| 955 |
|
|
Everything else in this specification is normative.</p> |
| 956 |
|
|
|
| 957 |
|
|
<p>The key words "MUST", "MUST NOT", "REQUIRED", <!--"SHALL", "SHALL |
| 958 |
|
|
NOT",--> "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and |
| 959 |
|
|
"OPTIONAL" in the normative parts of this document are to be |
| 960 |
|
|
interpreted as described in RFC2119. For readability, these words do |
| 961 |
|
|
not appear in all uppercase letters in this specification. <a href=#refsRFC2119>[RFC2119]</a></p> |
| 962 |
|
|
|
| 963 |
|
|
<p>Requirements phrased in the imperative as part of algorithms |
| 964 |
|
|
(such as "strip any leading space characters" or "return false and |
| 965 |
|
|
abort these steps") are to be interpreted with the meaning of the |
| 966 |
|
|
key word ("must", "should", "may", etc) used in introducing the |
| 967 |
|
|
algorithm.</p> |
| 968 |
|
|
|
| 969 |
|
|
<p>Some conformance requirements are phrased as requirements on |
| 970 |
|
|
attributes, methods or objects. Such requirements are to be |
| 971 |
|
|
interpreted as requirements on user agents.</p> |
| 972 |
|
|
|
| 973 |
|
|
<p>Conformance requirements phrased as algorithms or specific steps |
| 974 |
|
|
may be implemented in any manner, so long as the end result is |
| 975 |
|
|
equivalent. (In particular, the algorithms defined in this |
| 976 |
|
|
specification are intended to be easy to follow, and not intended to |
| 977 |
|
|
be performant.)</p> |
| 978 |
|
|
|
| 979 |
|
|
<p>The only conformance class defined by this specification is user |
| 980 |
|
|
agents.</p> |
| 981 |
|
|
|
| 982 |
|
|
<p>User agents may impose implementation-specific limits on |
| 983 |
|
|
otherwise unconstrained inputs, e.g. to prevent denial of service |
| 984 |
|
|
attacks, to guard against running out of memory, or to work around |
| 985 |
|
|
platform-specific limitations.</p> |
| 986 |
|
|
|
| 987 |
|
|
|
| 988 |
|
|
<h3 id=dependencies><span class=secno>2.1 </span>Dependencies</h3> |
| 989 |
|
|
|
| 990 |
|
|
<p>This specification relies on several other underlying |
| 991 |
|
|
specifications.</p> |
| 992 |
|
|
|
| 993 |
|
|
<dl><dt>HTML5</dt> |
| 994 |
|
|
|
| 995 |
|
|
<dd> |
| 996 |
|
|
|
| 997 |
|
|
<p>Many fundamental concepts from HTML5 are used by this |
| 998 |
|
|
specification. <a href=#refsHTML5>[HTML5]</a></p> |
| 999 |
|
|
|
| 1000 |
|
|
</dd> |
| 1001 |
|
|
|
| 1002 |
|
|
<dt>WebIDL</dt> |
| 1003 |
|
|
|
| 1004 |
|
|
<dd> |
| 1005 |
|
|
|
| 1006 |
|
|
<p>The IDL blocks in this specification use the semantics of the |
| 1007 |
|
|
WebIDL specification. <a href=#refsWebIDL>[WebIDL]</a></p> |
| 1008 |
|
|
|
| 1009 |
|
|
</dd> |
| 1010 |
|
|
|
| 1011 |
|
|
</dl><h2 id=terminology><span class=secno>3 </span>Terminology</h2> |
| 1012 |
|
|
|
| 1013 |
|
|
<p>The construction "a <code title="">Foo</code> object", where |
| 1014 |
|
|
<code title="">Foo</code> is actually an interface, is sometimes |
| 1015 |
|
|
used instead of the more accurate "an object implementing the |
| 1016 |
|
|
interface <code title="">Foo</code>".</p> |
| 1017 |
|
|
|
| 1018 |
|
|
<p>The term DOM is used to refer to the API set made available to |
| 1019 |
|
|
scripts in Web applications, and does not necessarily imply the |
| 1020 |
|
|
existence of an actual <code>Document</code> object or of any other |
| 1021 |
|
|
<code>Node</code> objects as defined in the DOM Core |
| 1022 |
|
|
specifications. <a href=#refsDOM3CORE>[DOM3CORE]</a></p> |
| 1023 |
|
|
|
| 1024 |
|
|
<p>A DOM attribute is said to be <em>getting</em> when its value is |
| 1025 |
|
|
being retrieved (e.g. by author script), and is said to be |
| 1026 |
|
|
<em>setting</em> when a new value is assigned to it.</p> |
| 1027 |
|
|
|
| 1028 |
|
|
<p>The term "JavaScript" is used to refer to ECMA262, rather than |
| 1029 |
|
|
the official term ECMAScript, since the term JavaScript is more |
| 1030 |
|
|
widely known. <a href=#refsECMA262>[ECMA262]</a></p> |
| 1031 |
|
|
|
| 1032 |
|
|
|
| 1033 |
|
|
<h2 id=infrastructure><span class=secno>4 </span>Infrastructure</h2> |
| 1034 |
|
|
|
| 1035 |
|
|
<p>There are two kinds of workers; dedicated workers, and shared |
| 1036 |
|
|
workers. Dedicated workers, once created, and are linked to their |
| 1037 |
|
|
creator; but message ports can be used to communicate from a |
| 1038 |
|
|
dedicated worker to multiple other browsing contexts or |
| 1039 |
|
|
workers. Shared workers, on the other hand, are named, and once |
| 1040 |
|
|
created any script running in the same <span>origin</span> can |
| 1041 |
|
|
obtain a reference to that worker and communicate with it.</p> |
| 1042 |
|
|
|
| 1043 |
|
|
|
| 1044 |
|
|
<h3 id=the-global-scope><span class=secno>4.1 </span>The global scope</h3> |
| 1045 |
|
|
|
| 1046 |
|
|
<p>The global scope is the "inside" of a worker.</p> |
| 1047 |
|
|
|
| 1048 |
|
|
<h4 id=the-workerglobalscope-abstract-interface><span class=secno>4.1.1 </span>The <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> abstract interface</h4> |
| 1049 |
|
|
|
| 1050 |
|
|
<pre class=idl>interface <dfn id=workerglobalscope>WorkerGlobalScope</dfn> { |
| 1051 |
|
|
readonly attribute <a href=#workerglobalscope>WorkerGlobalScope</a> <a href=#dom-workerglobalscope-self title=dom-WorkerGlobalScope-self>self</a>; |
| 1052 |
|
|
readonly attribute <a href=#workerlocation>WorkerLocation</a> <a href=#dom-workerglobalscope-location title=dom-WorkerGlobalScope-location>location</a>; |
| 1053 |
|
|
// also implements everything on <a href=#workerutils>WorkerUtils</a> |
| 1054 |
|
|
|
| 1055 |
|
|
void <a href=#dom-workerglobalscope-close title=dom-WorkerGlobalScope-close>close</a>(); |
| 1056 |
|
|
<!-- v2-onclose attribute <span>EventListener</span> <span title="handler-WorkerGlobalScope-onclose">onclose</span>; |
| 1057 |
|
|
--> attribute <span>EventListener</span> <a href=#handler-workerglobalscope-onerror title=handler-WorkerGlobalScope-onerror>onerror</a>; |
| 1058 |
|
|
};</pre> |
| 1059 |
|
|
|
| 1060 |
|
|
<p>Objects implementing the <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> interface |
| 1061 |
|
|
must also implement the <code>EventTarget</code> interface.</p> |
| 1062 |
|
|
|
| 1063 |
|
|
<p>The <dfn id=dom-workerglobalscope-self title=dom-WorkerGlobalScope-self><code>self</code></dfn> attribute |
| 1064 |
|
|
must return the <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object itself.</p> |
| 1065 |
|
|
|
| 1066 |
|
|
<p>The <dfn id=dom-workerglobalscope-location title=dom-WorkerGlobalScope-location><code>location</code></dfn> |
| 1067 |
|
|
attribute must return the <code><a href=#workerlocation>WorkerLocation</a></code> object created |
| 1068 |
|
|
for the <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object when the worker was |
| 1069 |
|
|
created. It represents the <span>absolute URL</span> of the script |
| 1070 |
wakaba |
1.83 |
that was used to initialize the worker, after any redirects.</p> |
| 1071 |
wakaba |
1.82 |
|
| 1072 |
|
|
<hr><p>When a script invokes the <dfn id=dom-workerglobalscope-close title=dom-WorkerGlobalScope-close><code>close()</code></dfn> |
| 1073 |
|
|
method on a <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object, the user agent |
| 1074 |
|
|
must run the following steps (atomically):</p> |
| 1075 |
|
|
|
| 1076 |
|
|
<ol><li><p>Discard any <span title=concept-task>tasks</span> that |
| 1077 |
|
|
have been added to the <span>event loop</span>'s <span title="task |
| 1078 |
|
|
queue">task queues</span>.</p> |
| 1079 |
|
|
|
| 1080 |
|
|
<!-- v2-onclose |
| 1081 |
|
|
<li><p><span>Queue a task</span> to <span>fire a simple |
| 1082 |
|
|
event</span> called <code title="event-close">close</code> at the |
| 1083 |
|
|
<code>WorkerGlobalScope</code> object.</p></li> |
| 1084 |
|
|
--> |
| 1085 |
|
|
|
| 1086 |
|
|
<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. (This prevents any further tasks from being queued.)</li> |
| 1089 |
|
|
|
| 1090 |
|
|
<li><p>Disentangle all the ports in the list of <a href="#the-worker's-ports">the worker's |
| 1091 |
|
|
ports</a>.</li> |
| 1092 |
|
|
|
| 1093 |
|
|
</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>) |
| 1094 |
|
|
that must be supported, as DOM attributes, by objects implementing |
| 1095 |
|
|
the <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> interface:</p> |
| 1096 |
|
|
|
| 1097 |
|
|
<table><thead><tr><th><span title="event handler attributes">event handler attribute</span> <th><span>Event handler event type</span> |
| 1098 |
|
|
<tbody><!-- v2-onclose <tr><td><dfn title="handler-WorkerGlobalScope-onclose"><code>onclose</code></dfn> <td> <code title="event-close">close</code> --><tr><td><dfn id=handler-workerglobalscope-onerror title=handler-WorkerGlobalScope-onerror><code>onerror</code></dfn> <td> <code title=event-error>error</code> |
| 1099 |
|
|
</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> |
| 1100 |
|
|
|
| 1101 |
wakaba |
1.93 |
<pre class=idl>[NoInterfaceObject, Supplemental] interface <dfn id=dedicatedworkerglobalscope>DedicatedWorkerGlobalScope</dfn> : <a href=#workerglobalscope>WorkerGlobalScope</a> { |
| 1102 |
wakaba |
1.82 |
void <a href=#dom-dedicatedworkerglobalscope-postmessage title=dom-DedicatedWorkerGlobalScope-postMessage>postMessage</a>(in any message, [Optional] in <span>MessagePortArray</span> ports);<!-- |
| 1103 |
|
|
<span>MessagePort</span> <span title="dom-DedicatedWorkerGlobalScope-startConversation">startConversation</span>(in any message);--> |
| 1104 |
|
|
attribute <span>EventListener</span> <a href=#handler-dedicatedworkerglobalscope-onmessage title=handler-DedicatedWorkerGlobalScope-onmessage>onmessage</a>; |
| 1105 |
|
|
};</pre> |
| 1106 |
|
|
|
| 1107 |
|
|
<p><code><a href=#dedicatedworkerglobalscope>DedicatedWorkerGlobalScope</a></code> objects act as if they |
| 1108 |
|
|
had an implicit <code>MessagePort</code> associated with them. This |
| 1109 |
|
|
port is part of a channel that is set up when the worker is created, |
| 1110 |
|
|
but it is not exposed. This object must never be garbage collected |
| 1111 |
|
|
before the <code><a href=#dedicatedworkerglobalscope>DedicatedWorkerGlobalScope</a></code> object.</p> |
| 1112 |
|
|
|
| 1113 |
|
|
<p>All messages received by that port must immediately be retargeted |
| 1114 |
|
|
at the <code><a href=#dedicatedworkerglobalscope>DedicatedWorkerGlobalScope</a></code> object.</p> |
| 1115 |
|
|
|
| 1116 |
|
|
<p>The <dfn id=dom-dedicatedworkerglobalscope-postmessage title=dom-DedicatedWorkerGlobalScope-postMessage><code>postMessage()</code></dfn><!-- |
| 1117 |
|
|
and <dfn |
| 1118 |
|
|
title="dom-DedicatedWorkerGlobalScope-startConversation"><code>startConversation()</code></dfn>--> |
| 1119 |
|
|
method<!--s (startConversation)--> on |
| 1120 |
|
|
<code><a href=#dedicatedworkerglobalscope>DedicatedWorkerGlobalScope</a></code> objects must act as if, when |
| 1121 |
|
|
invoked, it<!--/they (startConversation)--> immediately invoked the |
| 1122 |
|
|
method of the same name on the port, with the same arguments, and |
| 1123 |
|
|
returned the same return value.</p> |
| 1124 |
|
|
|
| 1125 |
|
|
<p>The following are the <span>event handler attributes</span> (and |
| 1126 |
|
|
their corresponding <span title="event handler event type">event |
| 1127 |
|
|
handler event types</span>) that must be supported, as DOM |
| 1128 |
|
|
attributes, by objects implementing the |
| 1129 |
|
|
<code><a href=#dedicatedworkerglobalscope>DedicatedWorkerGlobalScope</a></code> interface:</p> |
| 1130 |
|
|
|
| 1131 |
|
|
<table><thead><tr><th><span title="event handler attributes">event handler attribute</span> <th><span>Event handler event type</span> |
| 1132 |
|
|
<tbody><tr><td><dfn id=handler-dedicatedworkerglobalscope-onmessage title=handler-DedicatedWorkerGlobalScope-onmessage><code>onmessage</code></dfn> <td> <code title=event-message>message</code> |
| 1133 |
|
|
</table><p>For the purposes of the <span>offline application cache</span> |
| 1134 |
|
|
networking model, a dedicated worker is an extension of the |
| 1135 |
|
|
<span>cache host</span> from which it was created.</p> |
| 1136 |
|
|
|
| 1137 |
|
|
|
| 1138 |
|
|
|
| 1139 |
|
|
<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> |
| 1140 |
|
|
|
| 1141 |
wakaba |
1.93 |
<pre class=idl>[NoInterfaceObject, Supplemental] interface <dfn id=sharedworkerglobalscope>SharedWorkerGlobalScope</dfn> : <a href=#workerglobalscope>WorkerGlobalScope</a> { |
| 1142 |
wakaba |
1.82 |
readonly attribute DOMString <a href=#dom-sharedworkerglobalscope-name title=dom-SharedWorkerGlobalScope-name>name</a>; |
| 1143 |
|
|
readonly attribute <span>ApplicationCache</span> <a href=#dom-sharedworkerglobalscope-applicationcache title=dom-SharedWorkerGlobalScope-applicationCache>applicationCache</a>; |
| 1144 |
|
|
attribute <span>EventListener</span> <a href=#handler-sharedworkerglobalscope-onconnect title=handler-SharedWorkerGlobalScope-onconnect>onconnect</a>; |
| 1145 |
|
|
};</pre> |
| 1146 |
|
|
|
| 1147 |
|
|
<p>Shared workers receive message ports through <code title=event-WorkerGlobalScope-connect>connect</code> events on |
| 1148 |
|
|
their global object for each connection.</p> |
| 1149 |
|
|
|
| 1150 |
|
|
<p>The <dfn id=dom-sharedworkerglobalscope-name title=dom-SharedWorkerGlobalScope-name><code>name</code></dfn> |
| 1151 |
|
|
attribute must return the value it was assigned when the |
| 1152 |
|
|
<code><a href=#sharedworkerglobalscope>SharedWorkerGlobalScope</a></code> object was created by the |
| 1153 |
|
|
"<a href=#run-a-worker>run a worker</a>" algorithm. Its value represents the name |
| 1154 |
|
|
that can be used to obtain a reference to the worker using the |
| 1155 |
|
|
<code><a href=#sharedworker>SharedWorker</a></code> constructor.</p> |
| 1156 |
|
|
|
| 1157 |
|
|
<p>The following are the <span>event handler attributes</span> (and |
| 1158 |
|
|
their corresponding <span title="event handler event type">event |
| 1159 |
|
|
handler event types</span>) that must be supported, as DOM |
| 1160 |
|
|
attributes, by objects implementing the |
| 1161 |
|
|
<code><a href=#sharedworkerglobalscope>SharedWorkerGlobalScope</a></code> interface:</p> |
| 1162 |
|
|
|
| 1163 |
|
|
<table><thead><tr><th><span title="event handler attributes">event handler attribute</span> <th><span>Event handler event type</span> |
| 1164 |
|
|
<tbody><tr><td><dfn id=handler-sharedworkerglobalscope-onconnect title=handler-SharedWorkerGlobalScope-onconnect><code>onconnect</code></dfn> <td> <code title=event-connect>connect</code> |
| 1165 |
|
|
</table><p>For the purposes of the <span>offline application cache</span> |
| 1166 |
|
|
networking model, a shared worker is its own <span>cache |
| 1167 |
|
|
host</span>. The <a href=#run-a-worker>run a worker</a> algorithm takes care of |
| 1168 |
|
|
associating the worker with an <span>application cache</span>.</p> |
| 1169 |
|
|
|
| 1170 |
|
|
<p class=note>The <dfn id=dom-sharedworkerglobalscope-applicationcache title=dom-SharedWorkerGlobalScope-applicationCache><code>applicationCache</code></dfn> |
| 1171 |
|
|
attribute returns the <code>ApplicationCache</code> object for the |
| 1172 |
|
|
worker.</p><!-- normative conf criteria is in the appcache section |
| 1173 |
|
|
--> |
| 1174 |
|
|
|
| 1175 |
|
|
|
| 1176 |
|
|
<h3 id=base-urls-and-origins-of-workers><span class=secno>4.2 </span>Base URLs and origins of workers</h3> |
| 1177 |
|
|
|
| 1178 |
|
|
<p>Both the <span>origin</span> and <span>effective script |
| 1179 |
|
|
origin</span> of scripts running in workers are the |
| 1180 |
|
|
<span>origin</span> of the <span>absolute URL</span> given in that |
| 1181 |
|
|
the worker's <code title=dom-WorkerGlobalScope-location><a href=#dom-workerglobalscope-location>location</a></code> attribute |
| 1182 |
|
|
represents.</p> |
| 1183 |
|
|
|
| 1184 |
|
|
|
| 1185 |
|
|
<h3 id=decoding-scripts><span class=secno>4.3 </span>Decoding scripts</h3> |
| 1186 |
|
|
|
| 1187 |
|
|
<p>When a user agent is to <dfn id=decode-a-script-resource>decode a script resource</dfn> to |
| 1188 |
|
|
obtain its source in Unicode, it must run the following steps:</p> |
| 1189 |
|
|
|
| 1190 |
|
|
<ol><li> |
| 1191 |
|
|
|
| 1192 |
|
|
<p>Let <var title="">character encoding</var> be <i title="">unknown</i>.</p> |
| 1193 |
|
|
|
| 1194 |
|
|
</li> |
| 1195 |
|
|
|
| 1196 |
|
|
<li> |
| 1197 |
|
|
|
| 1198 |
|
|
<p>For each of the rows in the following table, starting with the |
| 1199 |
|
|
first one and going down, if the resource has as many or more |
| 1200 |
|
|
bytes available than the number of bytes in the first column, and |
| 1201 |
|
|
the first bytes of the resource match the bytes given in the first |
| 1202 |
|
|
column, then let <var title="">character encoding</var> be the |
| 1203 |
|
|
encoding given in the cell in the second column of that row:</p> |
| 1204 |
|
|
|
| 1205 |
|
|
<!-- this table is present in several forms in this file; keep them in sync --> |
| 1206 |
|
|
<table><thead><tr><th>Bytes in Hexadecimal |
| 1207 |
|
|
<th>Encoding |
| 1208 |
|
|
<tbody><!-- nobody uses this |
| 1209 |
|
|
<tr> |
| 1210 |
|
|
<td>00 00 FE FF |
| 1211 |
|
|
<td>UTF-32BE |
| 1212 |
|
|
<tr> |
| 1213 |
|
|
<td>FF FE 00 00 |
| 1214 |
|
|
<td>UTF-32LE |
| 1215 |
|
|
--><tr><td>FE FF |
| 1216 |
|
|
<td>UTF-16BE |
| 1217 |
|
|
<tr><td>FF FE |
| 1218 |
|
|
<td>UTF-16LE |
| 1219 |
|
|
<tr><td>EF BB BF |
| 1220 |
|
|
<td>UTF-8 |
| 1221 |
|
|
<!-- nobody uses this |
| 1222 |
|
|
<tr> |
| 1223 |
|
|
<td>DD 73 66 73 |
| 1224 |
|
|
<td>UTF-EBCDIC |
| 1225 |
|
|
--> |
| 1226 |
|
|
</table><p class=note>This step looks for Unicode Byte Order Marks |
| 1227 |
|
|
(BOMs).</p> |
| 1228 |
|
|
|
| 1229 |
|
|
</li> |
| 1230 |
|
|
|
| 1231 |
|
|
<li> |
| 1232 |
|
|
|
| 1233 |
|
|
<p>If <var title="">character encoding</var> is still <i title="">unknown</i>, apply the <span>algorithm for extracting an |
| 1234 |
|
|
encoding from a Content-Type</span> to the resource's <span title=Content-Type>Content Type metadata</span>; if this returns |
| 1235 |
|
|
an encoding, and the user agent supports that encoding, then let |
| 1236 |
|
|
<var title="">character encoding</var> be that encoding.</p> |
| 1237 |
|
|
|
| 1238 |
|
|
</li> |
| 1239 |
|
|
|
| 1240 |
|
|
<li> |
| 1241 |
|
|
|
| 1242 |
|
|
<p>If <var title="">character encoding</var> is still <i title="">unknown</i>, then let <var title="">character |
| 1243 |
|
|
encoding</var> be UTF-8.</p> |
| 1244 |
|
|
|
| 1245 |
|
|
</li> |
| 1246 |
|
|
|
| 1247 |
|
|
<li> |
| 1248 |
|
|
|
| 1249 |
|
|
<p>Convert the resource to Unicode using the character encoding |
| 1250 |
|
|
given by <var title="">character encoding</var>.</p> |
| 1251 |
|
|
|
| 1252 |
|
|
<p>Return the text that is so obtained.</p> |
| 1253 |
|
|
|
| 1254 |
|
|
</li> |
| 1255 |
|
|
|
| 1256 |
|
|
</ol><h3 id=the-event-loop><span class=secno>4.4 </span>The event loop</h3> |
| 1257 |
|
|
|
| 1258 |
wakaba |
1.83 |
<p>Each <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object has an <span>event |
| 1259 |
|
|
loop</span> distinct from those defined for <span title="unit of |
| 1260 |
|
|
related similar-origin browsing contexts">units of related |
| 1261 |
|
|
similar-origin browsing contexts</span>. This <span>event |
| 1262 |
|
|
loop</span> has no associated <span>browsing context</span>, and its |
| 1263 |
|
|
<span title="task queue">task queues</span> only have events, |
| 1264 |
|
|
callbacks, and networking activity as <span title=concept-task>tasks</span>. The processing model of these |
| 1265 |
|
|
<span title="event loop">event loops</span> is defined below in the |
| 1266 |
|
|
<a href=#run-a-worker>run a worker</a> algorithm.</p> |
| 1267 |
wakaba |
1.82 |
|
| 1268 |
|
|
<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 |
| 1269 |
|
|
initially be false, but which can get set to true by the algorithms |
| 1270 |
|
|
in the processing model section below.</p> |
| 1271 |
|
|
|
| 1272 |
|
|
<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 |
| 1273 |
|
|
true, the <span>event loop</span>'s <span title="task queue">task |
| 1274 |
|
|
queues</span> must discard any further <span title=concept-task>tasks</span> that would be added to them (tasks |
| 1275 |
|
|
already on the queue are unaffected unless otherwise |
| 1276 |
|
|
specified). Effectively, once the <a href=#dom-workerglobalscope-closing title=dom-WorkerGlobalScope-closing>closing</a> flag is true, |
| 1277 |
|
|
timers stop firing, notifications for all pending asynchronous |
| 1278 |
|
|
operations are dropped, etc.</p> |
| 1279 |
|
|
|
| 1280 |
|
|
|
| 1281 |
|
|
<h3 id="the-worker's-lifetime"><span class=secno>4.5 </span>The worker's lifetime</h3> |
| 1282 |
|
|
|
| 1283 |
|
|
<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 |
| 1284 |
|
|
<code>MessagePort</code> objects.</p> |
| 1285 |
|
|
|
| 1286 |
|
|
<p>Each <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> <var title="">worker global |
| 1287 |
|
|
scope</var> has a list of <dfn id="the-worker's-ports">the worker's ports</dfn>, which |
| 1288 |
|
|
consists of all the <code>MessagePort</code> objects that are |
| 1289 |
|
|
entangled with another port and that have one (but only one) port |
| 1290 |
|
|
owned by <var title="">worker global scope</var>. This list includes |
| 1291 |
|
|
<!--all the <code>MessagePort</code> objects that are in events |
| 1292 |
|
|
pending in the <span>event loop</span>, as well as (commented out |
| 1293 |
|
|
because in practice it makes no difference either way as far as I |
| 1294 |
|
|
can tell, and it would be hard to strictly implement since these |
| 1295 |
|
|
ports might not yet be across the thread boundary)--> the implicit |
| 1296 |
|
|
<code>MessagePort</code> in the case of <a href=#dedicatedworkerglobalscope title=DedicatedWorkerGlobalScope>dedicated workers</a>.</p> |
| 1297 |
|
|
|
| 1298 |
|
|
<p>Each <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> also has a list of <dfn id="the-worker's-workers">the |
| 1299 |
|
|
worker's workers</dfn>. Initially this list is empty; it is |
| 1300 |
|
|
populated when the worker creates or obtains further workers.</p> |
| 1301 |
|
|
|
| 1302 |
|
|
<p>Finally, each <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> also has a list of |
| 1303 |
|
|
<dfn id="the-worker's-documents">the worker's <code>Document</code>s</dfn>. Initially this list |
| 1304 |
|
|
is empty; it is populated when the worker is created.</p> |
| 1305 |
|
|
|
| 1306 |
|
|
<p>Whenever a <code>Document</code> <var title="">d</var> is <dfn id="add-a-document-to-the-worker's-documents" title="add a document to the worker's documents">added to the |
| 1307 |
|
|
worker's <code>Document</code>s</dfn>, the user agent must, for each |
| 1308 |
|
|
worker in the list of <a href="#the-worker's-workers">the worker's workers</a> whose list |
| 1309 |
|
|
of <a href="#the-worker's-documents">the worker's <code>Document</code>s</a> does not contain |
| 1310 |
|
|
<var title="">d</var>, <a href="#add-a-document-to-the-worker's-documents" title="add a document to the worker's |
| 1311 |
|
|
documents">add <var title="">d</var> to <var title="">q</var>'s |
| 1312 |
|
|
<code>WorkerGlobalScope</code> owner's list of <span>the worker's |
| 1313 |
|
|
<code>Document</code>s</span></a>.</p> <!-- suggestions welcome |
| 1314 |
|
|
on making this sentence into understandable English --> |
| 1315 |
|
|
|
| 1316 |
|
|
<p>Whenever a <code>Document</code> object is <span title="discard a |
| 1317 |
|
|
Document">discarded</span>, it must be removed from the list of |
| 1318 |
|
|
<a href="#the-worker's-documents">the worker's <code>Document</code>s</a> of each worker |
| 1319 |
|
|
whose list contains that <code>Document</code>.</p> |
| 1320 |
|
|
|
| 1321 |
|
|
<p>Given a <span>script's global scope</span> <var title="">o</var> |
| 1322 |
|
|
when creating or obtaining a worker, the <dfn id=list-of-relevant-document-objects-to-add>list of relevant |
| 1323 |
|
|
<code>Document</code> objects to add</dfn> depends on the type of |
| 1324 |
|
|
<var title="">o</var>. If <var title="">o</var> is a |
| 1325 |
|
|
<code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object (i.e. if we are creating a |
| 1326 |
|
|
nested worker), then the relevant <code>Document</code>s are the |
| 1327 |
|
|
<code>Document</code>s that are in <var title="">o</var>'s own list |
| 1328 |
|
|
of <a href="#the-worker's-documents">the worker's <code>Document</code>s</a>. Otherwise, <var title="">o</var> is a <code>Window</code> object, and the relevant |
| 1329 |
|
|
<code>Document</code> is just the <code>Document</code> that is the |
| 1330 |
|
|
<span>active document</span> of the <code>Window</code> object <var title="">o</var>.</p> |
| 1331 |
|
|
|
| 1332 |
|
|
<hr><p>A worker is said to be a <dfn id=permissible-worker>permissible worker</dfn> if its |
| 1333 |
|
|
list of <a href="#the-worker's-documents">the worker's <code>Document</code>s</a> is not |
| 1334 |
|
|
empty.</p> |
| 1335 |
|
|
|
| 1336 |
|
|
<p>A worker is said to be a <dfn id=protected-worker>protected worker</dfn> if it is a |
| 1337 |
|
|
<a href=#permissible-worker>permissible worker</a> and either it has outstanding |
| 1338 |
|
|
timers, database transactions, or network connections, or its list |
| 1339 |
|
|
of <a href="#the-worker's-ports">the worker's ports</a> is not empty, or its |
| 1340 |
|
|
<code><a href=#workerglobalscope>WorkerGlobalScope</a></code> is actually a |
| 1341 |
|
|
<code><a href=#sharedworkerglobalscope>SharedWorkerGlobalScope</a></code> object (i.e. the worker is a |
| 1342 |
|
|
shared worker).</p> |
| 1343 |
|
|
|
| 1344 |
|
|
<p>A worker is said to be an <dfn id=active-needed-worker>active needed worker</dfn> if any |
| 1345 |
|
|
of the <code>Document</code> objects in <a href="#the-worker's-documents">the worker's |
| 1346 |
|
|
<code>Document</code>s</a> are <span>fully active</span>.</p> |
| 1347 |
|
|
|
| 1348 |
|
|
<p>A worker is said to be a <dfn id=suspendable-worker>suspendable worker</dfn> if it is |
| 1349 |
|
|
not an <a href=#active-needed-worker>active needed worker</a> but it is a |
| 1350 |
|
|
<a href=#permissible-worker>permissible worker</a>.</p> |
| 1351 |
|
|
|
| 1352 |
|
|
|
| 1353 |
|
|
<h3 id=processing-model><span class=secno>4.6 </span>Processing model</h3> |
| 1354 |
|
|
|
| 1355 |
|
|
<p>When a user agent is to <dfn id=run-a-worker>run a worker</dfn> for a script with |
| 1356 |
|
|
<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 |
| 1357 |
|
|
steps:</p> |
| 1358 |
|
|
|
| 1359 |
|
|
<ol><li> |
| 1360 |
|
|
|
| 1361 |
|
|
<p>Create a completely separate and parallel execution environment |
| 1362 |
|
|
(i.e. a separate thread or process or equivalent construct), and |
| 1363 |
|
|
run the rest of these steps asynchronously in that context.</p> |
| 1364 |
|
|
|
| 1365 |
|
|
</li> |
| 1366 |
|
|
|
| 1367 |
|
|
<li><p>If <var title="">worker global scope</var> is actually a |
| 1368 |
|
|
<code><a href=#sharedworkerglobalscope>SharedWorkerGlobalScope</a></code> object (i.e. the worker is a |
| 1369 |
|
|
shared worker), and there are any <span title="relevant application |
| 1370 |
|
|
cache">relevant application caches</span> that are identified by a |
| 1371 |
|
|
manifest URL with the <span>same origin</span> as <var title="">url</var> and that have <var title="">url</var> as one of |
| 1372 |
|
|
their entries, <em>not</em> excluding entries marked as <span title=concept-appcache-foreign>foreign</span>, then associate the |
| 1373 |
|
|
<var title="">worker global scope</var> with the <span title=concept-appcache-selection>most appropriate application |
| 1374 |
|
|
cache</span> of those that match.</li> |
| 1375 |
|
|
|
| 1376 |
|
|
<li> |
| 1377 |
|
|
|
| 1378 |
|
|
<p>Attempt to <span>fetch</span> the resource identified by <var title="">url</var>.</p> |
| 1379 |
|
|
|
| 1380 |
wakaba |
1.83 |
<p>If the attempt fails, or if the attempt involves any redirects |
| 1381 |
|
|
to URIs that do not have the <span>same origin</span> as <var title="">url</var> (even if the final URI is at the <span>same |
| 1382 |
|
|
origin</span> as the original <var title="">url</var>), then for |
| 1383 |
|
|
each <code><a href=#worker>Worker</a></code> or <code><a href=#sharedworker>SharedWorker</a></code> object |
| 1384 |
|
|
associated with <var title="">worker global scope</var>, |
| 1385 |
|
|
<span>queue a task</span> to <span>fire a simple event</span> |
| 1386 |
|
|
called <code title=event-error>error</code> at that |
| 1387 |
|
|
object. Abort these steps.</p> |
| 1388 |
wakaba |
1.82 |
|
| 1389 |
|
|
<p>If the attempt succeeds, then <a href=#decode-a-script-resource title="decode a script |
| 1390 |
|
|
resource">decode the script resource</a> to obtain its <var title="">source</var>.</p> |
| 1391 |
|
|
|
| 1392 |
|
|
<p>Let <var title="">language</var> be JavaScript.</p> |
| 1393 |
|
|
|
| 1394 |
|
|
<p class=note>As with <code>script</code> elements, the MIME |
| 1395 |
|
|
type of the script is ignored. Unlike with <code>script</code> |
| 1396 |
|
|
elements, there is no way to override the type. It's always |
| 1397 |
|
|
assumed to be JavaScript.</p> <!-- XXX people will complain about |
| 1398 |
|
|
this. I guess we might want to examine the MIME type... --> |
| 1399 |
|
|
|
| 1400 |
|
|
</li> |
| 1401 |
|
|
|
| 1402 |
|
|
<li> |
| 1403 |
|
|
|
| 1404 |
|
|
<p>A new <span title=concept-script>script</span> is now |
| 1405 |
|
|
created, as follows.</p> |
| 1406 |
|
|
|
| 1407 |
|
|
<p>Create a new <span>script execution environment</span> |
| 1408 |
|
|
set up as appropriate for the scripting language <var title="">language</var>.</p> |
| 1409 |
|
|
|
| 1410 |
|
|
<p>Parse/compile/initialize <var title="">source</var> using that |
| 1411 |
|
|
<span>script execution environment</span>, as appropriate for <var title="">language</var>, and thus obtain a <span>list of code |
| 1412 |
|
|
entry-points</span>; set the <i>initial code entry-point</i> to |
| 1413 |
|
|
the entry-point for any executable code to be immediately run.</p> |
| 1414 |
|
|
|
| 1415 |
|
|
<p>Set the <span>script's global object</span> to <var title="">worker global scope</var>.</p> |
| 1416 |
|
|
|
| 1417 |
|
|
<p>Set the <span>script's browsing context</span> to <var title="">owner browsing context</var>.</p> |
| 1418 |
|
|
|
| 1419 |
|
|
<p>Set the <span>script's URL character encoding</span> to |
| 1420 |
|
|
UTF-8. (This is just used for encoding non-ASCII characters in the |
| 1421 |
|
|
query component of URLs.)</p> |
| 1422 |
|
|
|
| 1423 |
|
|
<p>Set the <span>script's base URL</span> to <var title="">url</var>.</p> |
| 1424 |
|
|
|
| 1425 |
|
|
</li> |
| 1426 |
|
|
|
| 1427 |
|
|
<li> |
| 1428 |
|
|
|
| 1429 |
|
|
<p><strong>Closing orphan workers</strong>: Start monitoring the |
| 1430 |
|
|
worker such that no sooner than it stops being either a |
| 1431 |
|
|
<a href=#protected-worker>protected worker</a> or a <a href=#suspendable-worker>suspendable |
| 1432 |
|
|
worker</a>, and no later than it stops being a |
| 1433 |
|
|
<a href=#permissible-worker>permissible worker</a>, <var title="">worker global |
| 1434 |
|
|
scope</var>'s <a href=#dom-workerglobalscope-closing title=dom-WorkerGlobalScope-closing>closing</a> flag is set |
| 1435 |
|
|
to true<!-- v2-onclose and <span title="queue a task">a task is |
| 1436 |
|
|
queued</span> to <span>fire a simple event</span> called <code |
| 1437 |
|
|
title="event-close">close</code> at <var title="">worker global |
| 1438 |
|
|
scope</var>-->.</p> |
| 1439 |
|
|
|
| 1440 |
|
|
</li> |
| 1441 |
|
|
|
| 1442 |
|
|
<li> |
| 1443 |
|
|
|
| 1444 |
|
|
<p><strong>Suspending workers</strong>: Start monitoring the |
| 1445 |
|
|
worker, such that whenever <var title="">worker global |
| 1446 |
|
|
scope</var>'s <a href=#dom-workerglobalscope-closing title=dom-WorkerGlobalScope-closing>closing</a> flag is false |
| 1447 |
|
|
and the worker is a <a href=#suspendable-worker>suspendable worker</a>, the user |
| 1448 |
|
|
agent suspends execution of script in that worker until such time |
| 1449 |
|
|
as either the <a href=#dom-workerglobalscope-closing title=dom-WorkerGlobalScope-closing>closing</a> flag switches |
| 1450 |
|
|
to true or the worker stops being a <a href=#suspendable-worker>suspendable |
| 1451 |
|
|
worker</a>.</p> |
| 1452 |
|
|
|
| 1453 |
|
|
</li> |
| 1454 |
|
|
|
| 1455 |
|
|
<li> |
| 1456 |
|
|
|
| 1457 |
|
|
<p><span title="jump to a code entry-point">Jump</span> to the |
| 1458 |
|
|
<span title=concept-script>script</span>'s <i>initial code |
| 1459 |
|
|
entry-point</i>, and let that run until it either returns, fails |
| 1460 |
|
|
to catch an exception, or gets prematurely aborted by the |
| 1461 |
|
|
"<a href=#kill-a-worker>kill a worker</a>" or "<a href=#terminate-a-worker>terminate a worker</a>" |
| 1462 |
|
|
algorithms defined below.</p> |
| 1463 |
|
|
|
| 1464 |
|
|
<p class=note>If the script gets aborted by the "<a href=#kill-a-worker>kill a |
| 1465 |
|
|
worker</a>" algorithm, then that same algorithm will cause |
| 1466 |
|
|
there to only be a single <span title=concept-task>task</span> |
| 1467 |
|
|
in the <span>event loop</span> at the next step, namely the task |
| 1468 |
|
|
for the <code title=message-close>close</code> event. The |
| 1469 |
|
|
"<a href=#terminate-a-worker>terminate a worker</a>" algorithm removes all the |
| 1470 |
|
|
events.</p> |
| 1471 |
|
|
|
| 1472 |
|
|
</li> |
| 1473 |
|
|
|
| 1474 |
|
|
<li><p>If <var title="">worker global scope</var> is actually a |
| 1475 |
|
|
<code><a href=#dedicatedworkerglobalscope>DedicatedWorkerGlobalScope</a></code> object (i.e. the worker is |
| 1476 |
|
|
a dedicated worker), then enable the <span>port message |
| 1477 |
|
|
queue</span> of the worker's implicit port.</li> |
| 1478 |
|
|
|
| 1479 |
|
|
<li> |
| 1480 |
|
|
|
| 1481 |
|
|
<p><i title="">Event loop</i>: Wait until either there is a <span title=concept-task>task</span> in one of the <span>event |
| 1482 |
|
|
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 |
| 1483 |
|
|
to true.</p> |
| 1484 |
|
|
|
| 1485 |
|
|
</li> |
| 1486 |
|
|
|
| 1487 |
|
|
<li> |
| 1488 |
|
|
|
| 1489 |
|
|
<p>Run the oldest task on one of the <span>event loop</span>'s |
| 1490 |
|
|
<span title="task queue">task queues</span>, if any. The user |
| 1491 |
|
|
agent may pick any <span>task queue</span>.</p> |
| 1492 |
|
|
|
| 1493 |
|
|
<p class=note>The handling of events or the execution of |
| 1494 |
|
|
callbacks might get prematurely aborted by the "<a href=#kill-a-worker>kill a |
| 1495 |
|
|
worker</a>" or "<a href=#terminate-a-worker>terminate a worker</a>" algorithms |
| 1496 |
|
|
defined below.</p> |
| 1497 |
|
|
|
| 1498 |
|
|
</li> |
| 1499 |
|
|
|
| 1500 |
|
|
<li> |
| 1501 |
|
|
|
| 1502 |
|
|
<p>Remove the task run in the previous step, if any, from its |
| 1503 |
|
|
<span>task queue</span>.</p> |
| 1504 |
|
|
|
| 1505 |
|
|
</li> |
| 1506 |
|
|
|
| 1507 |
|
|
<li> |
| 1508 |
|
|
|
| 1509 |
|
|
<p>If there are any more events in the <span>event loop</span>'s |
| 1510 |
|
|
<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 |
| 1511 |
|
|
to false, then jump back to the step above labeled <i>event |
| 1512 |
|
|
loop</i>.</p> |
| 1513 |
|
|
|
| 1514 |
|
|
</li> |
| 1515 |
|
|
|
| 1516 |
|
|
<li> |
| 1517 |
|
|
|
| 1518 |
|
|
<p>If there are any outstanding transactions that have callbacks |
| 1519 |
|
|
that involve <span title=concept-script>scripts</span> whose |
| 1520 |
|
|
<span title="script's global object">global object</span> is the |
| 1521 |
|
|
<var title="">worker global scope</var>, roll them back (without |
| 1522 |
|
|
invoking any of the callbacks).</p> |
| 1523 |
|
|
|
| 1524 |
|
|
</li> |
| 1525 |
|
|
|
| 1526 |
|
|
<li> |
| 1527 |
|
|
|
| 1528 |
|
|
<p>Empty the <var title="">worker global scope</var>'s <span>list |
| 1529 |
|
|
of active timeouts</span> and its <span>list of active |
| 1530 |
|
|
intervals</span>.</p> |
| 1531 |
|
|
|
| 1532 |
|
|
</li> |
| 1533 |
|
|
|
| 1534 |
|
|
<!-- v2-onclose |
| 1535 |
|
|
<li> |
| 1536 |
|
|
|
| 1537 |
|
|
<p>For each <code>Worker</code> or <code>SharedWorker</code> |
| 1538 |
|
|
object associated with <var title="">worker global scope</var>, |
| 1539 |
|
|
<span>queue a task</span> to <span>fire a simple event</span> |
| 1540 |
|
|
called <code title="event-close">close</code> at that object.</p> |
| 1541 |
|
|
|
| 1542 |
|
|
</li> |
| 1543 |
|
|
--> |
| 1544 |
|
|
</ol><hr><p>When a user agent is to <dfn id=kill-a-worker>kill a worker</dfn> it must |
| 1545 |
|
|
run the following steps in parallel with the worker's main loop (the |
| 1546 |
|
|
"<a href=#run-a-worker>run a worker</a>" processing model defined above):</p> |
| 1547 |
|
|
|
| 1548 |
|
|
<ol><!-- v2-onclose |
| 1549 |
|
|
<li><p>If the worker's <code>WorkerGlobalScope</code> object's |
| 1550 |
|
|
<span title="dom-WorkerGlobalScope-closing">closing</span> flag is |
| 1551 |
|
|
false, <span>queue a task</span> to <span>fire a simple |
| 1552 |
|
|
event</span> called <code title="event-close">close</code> at the |
| 1553 |
|
|
worker's <code>WorkerGlobalScope</code> object.</p></li> |
| 1554 |
|
|
--><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 |
| 1555 |
|
|
true.</li> |
| 1556 |
|
|
|
| 1557 |
|
|
<!-- v2-onclose |
| 1558 |
|
|
<li><p>Wait a user-agent-defined amount of time. If the "<span>run |
| 1559 |
|
|
a worker</span>" processing model defined above immediately starts |
| 1560 |
|
|
running event listeners registered for the <code |
| 1561 |
|
|
title="event-close">close</code> event, this time should not be |
| 1562 |
|
|
zero — the idea is that the <code |
| 1563 |
|
|
title="event-close">close</code> event can be used to clean up |
| 1564 |
|
|
when shutting down unexpectedly.</p></li> |
| 1565 |
|
|
--> |
| 1566 |
|
|
|
| 1567 |
|
|
<li><p>If there are any <span title=concept-task>tasks</span> |
| 1568 |
|
|
queued in the <span>event loop</span>'s <span title="task |
| 1569 |
|
|
queue">task queues</span><!-- v2-onclose other than the <code |
| 1570 |
|
|
title="event-close">close</code> event that this algorithm just |
| 1571 |
|
|
added-->, discard them without processing them.</li> |
| 1572 |
|
|
|
| 1573 |
|
|
<!-- v2-onclose |
| 1574 |
|
|
<li><p>If the <code title="event-close">close</code> event that |
| 1575 |
|
|
this algorithm just queued hasn't yet been dispatched, then abort |
| 1576 |
|
|
the script currently running in the worker.</p></li> |
| 1577 |
|
|
--> |
| 1578 |
|
|
|
| 1579 |
|
|
<li><p>Wait a user-agent-defined amount of time.</li> |
| 1580 |
|
|
|
| 1581 |
|
|
<li><p>Abort the script currently running in the worker<!-- |
| 1582 |
|
|
v2-onclose (if any script is running, then it will be a handler for |
| 1583 |
|
|
the <code title="event-close">close</code> event)-->.</li> |
| 1584 |
|
|
|
| 1585 |
|
|
</ol><p>User agents may invoke the "<a href=#kill-a-worker>kill a worker</a>" |
| 1586 |
|
|
processing model on a worker at any time, e.g. in response to user |
| 1587 |
|
|
requests, in response to CPU quota management, or when a worker |
| 1588 |
|
|
stops being an <a href=#active-needed-worker>active needed worker</a> if the worker |
| 1589 |
|
|
continues executing even after its <a href=#dom-workerglobalscope-closing title=dom-WorkerGlobalScope-closing>closing</a> flag was |
| 1590 |
|
|
set to true.</p> |
| 1591 |
|
|
|
| 1592 |
|
|
<hr><p>When a user agent is to <dfn id=terminate-a-worker>terminate a worker</dfn> it must run |
| 1593 |
|
|
the following steps in parallel with the worker's main loop (the |
| 1594 |
|
|
"<a href=#run-a-worker>run a worker</a>" processing model defined above):</p> |
| 1595 |
|
|
|
| 1596 |
|
|
<ol><li><p>Set the worker's <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object's |
| 1597 |
|
|
<a href=#dom-workerglobalscope-closing title=dom-WorkerGlobalScope-closing>closing</a> flag to |
| 1598 |
|
|
true.</li> |
| 1599 |
|
|
|
| 1600 |
|
|
<li><p>If there are any <span title=concept-task>tasks</span> |
| 1601 |
|
|
queued in the <span>event loop</span>'s <span title="task |
| 1602 |
|
|
queue">task queues</span>, discard them without processing |
| 1603 |
|
|
them.</li> |
| 1604 |
|
|
|
| 1605 |
|
|
<li><p>Abort the script currently running in the worker.</li> |
| 1606 |
|
|
|
| 1607 |
|
|
<li><p>If the worker's <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object is |
| 1608 |
|
|
actually a <code><a href=#dedicatedworkerglobalscope>DedicatedWorkerGlobalScope</a></code> object (i.e. the |
| 1609 |
|
|
worker is a dedicated worker), then empty the <span>port message |
| 1610 |
|
|
queue</span> of the port that the worker's implicit port is |
| 1611 |
|
|
entangled with.</li> |
| 1612 |
|
|
|
| 1613 |
|
|
</ol><h3 id=runtime-script-errors><span class=secno>4.7 </span>Runtime script errors</h3> |
| 1614 |
|
|
|
| 1615 |
|
|
<p>Whenever a runtime script error occurs in one of the worker's |
| 1616 |
|
|
scripts, if the error did not occur while handling a previous script |
| 1617 |
|
|
error, the user agent must <span>report the error</span> using the |
| 1618 |
|
|
<code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object's <code title=handler-WorkerGlobalScope-onerror><a href=#handler-workerglobalscope-onerror>onerror</a></code> |
| 1619 |
|
|
attribute.</p> |
| 1620 |
|
|
|
| 1621 |
|
|
<p>For shared workers, if the error is still <i title=concept-error-nothandled>not handled</i> afterwards, or if |
| 1622 |
wakaba |
1.91 |
the error occurred while handling a previous script error, the error |
| 1623 |
wakaba |
1.82 |
should be reported to the user.</p> |
| 1624 |
|
|
|
| 1625 |
|
|
<p>For dedicated workers, if the error is still <i title=concept-error-nothandled>not handled</i> afterwards, or if |
| 1626 |
wakaba |
1.91 |
the error occurred while handling a previous script error, the user |
| 1627 |
wakaba |
1.82 |
agent must <span>queue a task</span> to <a href=#fire-a-worker-error-event>fire a worker error |
| 1628 |
|
|
event</a> at the <code><a href=#worker>Worker</a></code> object associated with the |
| 1629 |
|
|
worker.</p> |
| 1630 |
|
|
|
| 1631 |
|
|
<p>When the user agent is to <dfn id=fire-a-worker-error-event>fire a worker error event</dfn> at |
| 1632 |
|
|
a <code><a href=#worker>Worker</a></code> object, it must dispatch an event that uses |
| 1633 |
|
|
the <code><a href=#errorevent>ErrorEvent</a></code> interface, with the name <code title=event-error>error</code>, that doesn't bubble and is |
| 1634 |
|
|
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 |
| 1635 |
|
|
appropriately. The default action of this event depends on whether |
| 1636 |
|
|
the <code><a href=#worker>Worker</a></code> object is itself in a worker. If it is, and |
| 1637 |
|
|
that worker is also a dedicated worker, then the user agent must |
| 1638 |
|
|
again <span>queue a task</span> to <a href=#fire-a-worker-error-event>fire a worker error |
| 1639 |
|
|
event</a> at the <code><a href=#worker>Worker</a></code> object associated with |
| 1640 |
|
|
<em>that</em> worker. Otherwise, then the error should be reported |
| 1641 |
|
|
to the user.</p> |
| 1642 |
|
|
|
| 1643 |
|
|
<hr><pre class=idl>interface <dfn id=errorevent>ErrorEvent</dfn> : Event { |
| 1644 |
|
|
readonly attribute DOMObject <a href=#dom-errorevent-message title=dom-ErrorEvent-message>message</a>; |
| 1645 |
|
|
readonly attribute DOMObject <a href=#dom-errorevent-filename title=dom-ErrorEvent-filename>filename</a>; |
| 1646 |
|
|
readonly attribute unsigned long <a href=#dom-errorevent-lineno title=dom-ErrorEvent-lineno>lineno</a>; |
| 1647 |
|
|
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); |
| 1648 |
|
|
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); |
| 1649 |
|
|
};</pre> |
| 1650 |
|
|
|
| 1651 |
|
|
<p>The <dfn id=dom-errorevent-initerrorevent title=dom-ErrorEvent-initErrorEvent><code>initErrorEvent()</code></dfn> |
| 1652 |
|
|
and <dfn id=dom-errorevent-initerroreventns title=dom-ErrorEvent-initErrorEventNS><code>initErrorEventNS()</code></dfn> |
| 1653 |
|
|
methods must initialize the event in a manner analogous to the |
| 1654 |
|
|
similarly-named methods in the DOM3 Events interfaces. <a href=#refsDOM3EVENTS>[DOM3EVENTS]</a></p> |
| 1655 |
|
|
|
| 1656 |
|
|
<p>The <dfn id=dom-errorevent-message title=dom-ErrorEvent-message><code>message</code></dfn> |
| 1657 |
|
|
attribute represents the error message.</p> |
| 1658 |
|
|
|
| 1659 |
|
|
<p>The <dfn id=dom-errorevent-filename title=dom-ErrorEvent-filename><code>filename</code></dfn> |
| 1660 |
|
|
attribute represents the <span>absolute URL</span> of the script in |
| 1661 |
wakaba |
1.91 |
which the error originally occurred.</p> |
| 1662 |
wakaba |
1.82 |
|
| 1663 |
|
|
<p>The <dfn id=dom-errorevent-lineno title=dom-ErrorEvent-lineno><code>lineno</code></dfn> |
| 1664 |
wakaba |
1.91 |
attribute represents the line number where the error occurred in the |
| 1665 |
wakaba |
1.82 |
script.</p> |
| 1666 |
|
|
|
| 1667 |
|
|
|
| 1668 |
|
|
|
| 1669 |
|
|
<h3 id=creating-workers><span class=secno>4.8 </span>Creating workers</h3> |
| 1670 |
|
|
|
| 1671 |
|
|
<h4 id=the-abstractworker-abstract-interface><span class=secno>4.8.1 </span>The <code><a href=#abstractworker>AbstractWorker</a></code> abstract interface</h4> |
| 1672 |
|
|
|
| 1673 |
|
|
<pre class=idl>interface <dfn id=abstractworker>AbstractWorker</dfn> { |
| 1674 |
|
|
attribute <span>EventListener</span> <a href=#handler-abstractworker-onerror title=handler-AbstractWorker-onerror>onerror</a>; |
| 1675 |
|
|
<!-- v2-onclose attribute <span>EventListener</span> <span title="handler-AbstractWorker-onclose">onclose</span>; --> |
| 1676 |
|
|
};</pre> |
| 1677 |
|
|
|
| 1678 |
|
|
<p>Objects implementing the <code><a href=#abstractworker>AbstractWorker</a></code> interface |
| 1679 |
|
|
must also implement the <code>EventTarget</code> interface.</p> |
| 1680 |
|
|
|
| 1681 |
|
|
<p>The following are the <span>event handler attributes</span> (and their corresponding <span title="event handler event type">event handler event types</span>) |
| 1682 |
|
|
that must be supported, as DOM attributes, by objects implementing |
| 1683 |
|
|
the <code><a href=#abstractworker>AbstractWorker</a></code> interface:</p> |
| 1684 |
|
|
|
| 1685 |
|
|
<table><thead><tr><th><span title="event handler attributes">event handler attribute</span> <th><span>Event handler event type</span> |
| 1686 |
|
|
<tbody><tr><td><dfn id=handler-abstractworker-onerror title=handler-AbstractWorker-onerror><code>onerror</code></dfn> <td> <code title=event-error>error</code> |
| 1687 |
|
|
<!-- v2-onclose <tr><td><dfn title="handler-AbstractWorker-onclose"><code>onclose</code></dfn> <td> <code title="event-close">close</code> --> |
| 1688 |
|
|
</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> |
| 1689 |
|
|
|
| 1690 |
|
|
<pre class=idl>[<a href=#dom-worker title=dom-Worker>Constructor</a>(in DOMString scriptURL)] |
| 1691 |
|
|
interface <dfn id=worker>Worker</dfn> : <a href=#abstractworker>AbstractWorker</a> { |
| 1692 |
|
|
void <a href=#dom-worker-terminate title=dom-Worker-terminate>terminate</a>(); |
| 1693 |
|
|
|
| 1694 |
|
|
void <a href=#dom-worker-postmessage title=dom-Worker-postMessage>postMessage</a>(in any message, [Optional] in <span>MessagePortArray</span> ports);<!-- |
| 1695 |
|
|
<span>MessagePort</span> <span title="dom-Worker-startConversation">startConversation</span>(in any message);--> |
| 1696 |
|
|
attribute <span>EventListener</span> <a href=#handler-worker-onmessage title=handler-Worker-onmessage>onmessage</a>; |
| 1697 |
|
|
};</pre> |
| 1698 |
|
|
|
| 1699 |
|
|
<p>The <dfn id=dom-worker-terminate title=dom-Worker-terminate><code>terminate()</code></dfn> method, |
| 1700 |
|
|
when invoked, must cause the "<a href=#terminate-a-worker>terminate a worker</a>" |
| 1701 |
|
|
algorithm to be run on the worker with with the object is |
| 1702 |
|
|
associated.</p> |
| 1703 |
|
|
|
| 1704 |
|
|
<p><code><a href=#worker>Worker</a></code> objects act as if they had an implicit |
| 1705 |
|
|
<code>MessagePort</code> associated with them. This port is part of |
| 1706 |
|
|
a channel that is set up when the worker is created, but it is not |
| 1707 |
|
|
exposed. This object must never be garbage collected before the |
| 1708 |
|
|
<code><a href=#worker>Worker</a></code> object.</p> |
| 1709 |
|
|
|
| 1710 |
|
|
<p>All messages received by that port must immediately be retargeted |
| 1711 |
|
|
at the <code><a href=#worker>Worker</a></code> object.</p> |
| 1712 |
|
|
|
| 1713 |
|
|
<p>The <dfn id=dom-worker-postmessage title=dom-Worker-postMessage><code>postMessage()</code></dfn><!-- |
| 1714 |
|
|
and <dfn |
| 1715 |
|
|
title="dom-Worker-startConversation"><code>startConversation()</code></dfn>--> |
| 1716 |
|
|
method<!--s (startConversation)--> on <code><a href=#worker>Worker</a></code> objects |
| 1717 |
|
|
must act as if, when invoked, it<!--/they (startConversation)--> |
| 1718 |
|
|
immediately invoked the method of the same name on the port, with |
| 1719 |
|
|
the same arguments, and returned the same return value.</p> |
| 1720 |
|
|
|
| 1721 |
|
|
<p>The following are the <span>event handler attributes</span> (and their corresponding <span title="event handler event type">event handler event types</span>) |
| 1722 |
|
|
that must be supported, as DOM attributes, by objects implementing |
| 1723 |
|
|
the <code><a href=#worker>Worker</a></code> interface:</p> |
| 1724 |
|
|
|
| 1725 |
|
|
<table><thead><tr><th><span title="event handler attributes">event handler attribute</span> <th><span>Event handler event type</span> |
| 1726 |
|
|
<tbody><tr><td><dfn id=handler-worker-onmessage title=handler-Worker-onmessage><code>onmessage</code></dfn> <td> <code title=event-message>message</code> |
| 1727 |
|
|
</table><hr><p>When the <dfn id=dom-worker title=dom-Worker><code>Worker(<var title="">scriptURL</var>)</code></dfn> constructor is invoked, the |
| 1728 |
|
|
user agent must run the following steps:</p> |
| 1729 |
|
|
|
| 1730 |
wakaba |
1.92 |
<ol><li><p><span title="resolve a url">Resolve</span> the <var title="">scriptURL</var> argument relative to the <span>first |
| 1731 |
|
|
script</span>'s <span title="script's base URL">base URL</span>, |
| 1732 |
|
|
when the method is invoked.</li> |
| 1733 |
wakaba |
1.82 |
|
| 1734 |
|
|
<li><p>If this fails, throw a <code>SYNTAX_ERR</code> |
| 1735 |
|
|
exception.</li> |
| 1736 |
|
|
|
| 1737 |
|
|
<li><p>If the <span>origin</span> of the resulting <span>absolute |
| 1738 |
|
|
URL</span> is not the <span title="same origin">same</span> as the |
| 1739 |
|
|
origin of the <span title=concept-script>script</span> that |
| 1740 |
|
|
invoked the constructor, then throw a <span>security |
| 1741 |
|
|
exception</span>.</li> |
| 1742 |
|
|
|
| 1743 |
|
|
<li><p><span>Create a new <code><a href=#dedicatedworkerglobalscope>DedicatedWorkerGlobalScope</a></code> |
| 1744 |
|
|
object</span>. Let <var title="">worker global scope</var> be this |
| 1745 |
|
|
new object.</li> |
| 1746 |
|
|
|
| 1747 |
|
|
<li><p>Create a new <code><a href=#worker>Worker</a></code> object, associated with |
| 1748 |
|
|
<var title="">worker global scope</var>. Let <var title="">worker</var> be this new object.</li> |
| 1749 |
|
|
|
| 1750 |
|
|
<li><p><span>Create a <code>MessagePort</code> object</span> owned |
| 1751 |
|
|
by the <span title="script's global scope">global scope</span> of |
| 1752 |
|
|
the <span title=concept-script>script</span> that invoked the |
| 1753 |
|
|
constructor. Let this be the <var title="">outside |
| 1754 |
|
|
port</var>.</li> |
| 1755 |
|
|
|
| 1756 |
|
|
<li><p>Associate the <var title="">outside port</var> with <var title="">worker</var>.</li> |
| 1757 |
|
|
|
| 1758 |
|
|
<li><p><span>Create a <code>MessagePort</code> object</span> owned |
| 1759 |
|
|
by <var title="">worker global scope</var>. Let <var title="">inside port</var> be this new object.</li> |
| 1760 |
|
|
|
| 1761 |
|
|
<li><p>Associate <var title="">inside port</var> with <var title="">worker global scope</var>.</li> |
| 1762 |
|
|
|
| 1763 |
|
|
<li><p><span>Entangle</span> <var title="">outside port</var> and |
| 1764 |
|
|
<var title="">inside port</var>.</li> |
| 1765 |
|
|
|
| 1766 |
|
|
<li><p>Return <var title="">worker</var>, and run the following |
| 1767 |
|
|
steps asynchronously.</li> |
| 1768 |
|
|
|
| 1769 |
|
|
<li><p>Enable <var title="">inside port</var>'s <span>port message |
| 1770 |
|
|
queue</span>.</li> |
| 1771 |
|
|
|
| 1772 |
|
|
<li><p>Enable <var title="">outside port</var>'s <span>port message |
| 1773 |
|
|
queue</span>.</li> |
| 1774 |
|
|
|
| 1775 |
|
|
<li> |
| 1776 |
|
|
|
| 1777 |
|
|
<p>Let <var title="">docs</var> be the <a href=#list-of-relevant-document-objects-to-add>list of relevant |
| 1778 |
|
|
<code>Document</code> objects to add</a> given the <span title="script's global scope">global scope</span> of the <span title=concept-script>script</span> that invoked the |
| 1779 |
|
|
constructor.</p> |
| 1780 |
|
|
|
| 1781 |
|
|
</li> |
| 1782 |
|
|
|
| 1783 |
|
|
<li> |
| 1784 |
|
|
|
| 1785 |
|
|
<p><a href="#add-a-document-to-the-worker's-documents" title="add a document to the worker's documents">Add to |
| 1786 |
|
|
<var title="">worker global scope</var>'s list of <span>the |
| 1787 |
|
|
worker's <code>Document</code>s</span></a> the |
| 1788 |
|
|
<code>Document</code> objects in <var title="">docs</var>.</p> |
| 1789 |
|
|
|
| 1790 |
|
|
</li> |
| 1791 |
|
|
|
| 1792 |
|
|
<li> |
| 1793 |
|
|
|
| 1794 |
|
|
<p>If the <span title="script's global scope">global scope</span> |
| 1795 |
|
|
of the <span title=concept-script>script</span> that invoked the |
| 1796 |
|
|
constructor is a <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object (i.e. we |
| 1797 |
|
|
are creating a nested worker), add <var title="">worker global |
| 1798 |
|
|
scope</var> to the list of <a href="#the-worker's-workers">the worker's workers</a> of the |
| 1799 |
|
|
<code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object that is the <span title="script's global scope">global scope</span> of the <span title=concept-script>script</span> that invoked the |
| 1800 |
|
|
constructor.</p> |
| 1801 |
|
|
|
| 1802 |
|
|
</li> |
| 1803 |
|
|
|
| 1804 |
|
|
<li> |
| 1805 |
|
|
|
| 1806 |
|
|
<p><a href=#run-a-worker>Run a worker</a> for the resulting <span>absolute |
| 1807 |
|
|
URL</span>, with the <span>script browsing context</span> of the |
| 1808 |
|
|
script that invoked the method as the <var title="">owner browsing |
| 1809 |
|
|
context</var>, and with <var title="">worker global scope</var> as |
| 1810 |
|
|
the global scope.</p> |
| 1811 |
|
|
|
| 1812 |
|
|
</li> |
| 1813 |
|
|
|
| 1814 |
wakaba |
1.95 |
</ol><p>This constructor must be visible when the <span>script's global |
| 1815 |
|
|
scope</span> is either a <code>Window</code> object or an object |
| 1816 |
|
|
implementing the <code><a href=#workerutils>WorkerUtils</a></code> interface.</p> |
| 1817 |
|
|
|
| 1818 |
|
|
|
| 1819 |
|
|
<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> |
| 1820 |
wakaba |
1.82 |
|
| 1821 |
|
|
<pre class=idl>[<a href=#dom-sharedworker title=dom-SharedWorker>Constructor</a>(in DOMString scriptURL, in DOMString name)] |
| 1822 |
|
|
interface <dfn id=sharedworker>SharedWorker</dfn> : <a href=#abstractworker>AbstractWorker</a> { |
| 1823 |
|
|
readonly attribute <span>MessagePort</span> <a href=#dom-sharedworker-port title=dom-SharedWorker-port>port</a>; |
| 1824 |
|
|
};</pre> |
| 1825 |
|
|
|
| 1826 |
|
|
<p>The <dfn id=dom-sharedworker-port title=dom-SharedWorker-port><code>port</code></dfn> |
| 1827 |
|
|
attribute must return the value it was assigned by the object's |
| 1828 |
|
|
constructor. It represents the <code>MessagePort</code> for |
| 1829 |
|
|
communicating with the shared worker.</p> |
| 1830 |
|
|
|
| 1831 |
|
|
<p>When the <dfn id=dom-sharedworker title=dom-SharedWorker><code>SharedWorker(<var title="">scriptURL</var>, <var title="">name</var>)</code></dfn> |
| 1832 |
|
|
constructor is invoked, the user agent must run the following |
| 1833 |
|
|
steps:</p> |
| 1834 |
|
|
|
| 1835 |
|
|
<ol><li><p><span title="resolve a url">Resolve</span> the <var title="">scriptURL</var> argument.</li> |
| 1836 |
|
|
|
| 1837 |
|
|
<li><p>If this fails, throw a <code>SYNTAX_ERR</code> |
| 1838 |
|
|
exception.</li> |
| 1839 |
|
|
|
| 1840 |
|
|
<li><p>If the <span>origin</span> of the resulting <span>absolute |
| 1841 |
|
|
URL</span> is not the <span title="same origin">same</span> as the |
| 1842 |
|
|
origin of the script that invoked the constructor, then throw a |
| 1843 |
|
|
<span>security exception</span>.</li> |
| 1844 |
|
|
|
| 1845 |
|
|
<li> |
| 1846 |
|
|
|
| 1847 |
|
|
<p>Let <var title="">docs</var> be the <a href=#list-of-relevant-document-objects-to-add>list of relevant |
| 1848 |
|
|
<code>Document</code> objects to add</a> given the <span title="script's global scope">global scope</span> of the <span title=concept-script>script</span> that invoked the |
| 1849 |
|
|
constructor.</p> |
| 1850 |
|
|
|
| 1851 |
|
|
</li> |
| 1852 |
|
|
|
| 1853 |
|
|
<li> |
| 1854 |
|
|
|
| 1855 |
|
|
<p>Execute the following substeps atomically:</p> |
| 1856 |
|
|
|
| 1857 |
|
|
<ol><li><p>Create a new <code><a href=#sharedworker>SharedWorker</a></code> object, which will |
| 1858 |
|
|
shortly be associated with a <code><a href=#sharedworkerglobalscope>SharedWorkerGlobalScope</a></code> |
| 1859 |
|
|
object. Let this <code><a href=#sharedworker>SharedWorker</a></code> object be <var title="">worker</var>.</li> |
| 1860 |
|
|
|
| 1861 |
|
|
<li><p><span>Create a <code>MessagePort</code> object</span> |
| 1862 |
|
|
owned by the <span title="script's global scope">global |
| 1863 |
|
|
scope</span> of the script that invoked the method. Let this be |
| 1864 |
|
|
the <var title="">outside port</var>.</li> |
| 1865 |
|
|
|
| 1866 |
|
|
<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> |
| 1867 |
|
|
|
| 1868 |
|
|
<li> |
| 1869 |
|
|
|
| 1870 |
|
|
<p>If there exists a <code><a href=#sharedworkerglobalscope>SharedWorkerGlobalScope</a></code> object |
| 1871 |
|
|
whose <a href=#dom-workerglobalscope-closing title=dom-WorkerGlobalScope-closing>closing</a> |
| 1872 |
|
|
flag is false, whose <code title=dom-WorkerGlobalScope-name>name</code> attribute is |
| 1873 |
|
|
exactly equal to the <var title="">name</var> argument, and |
| 1874 |
|
|
whose <code title=dom-WorkerGlobalScope-location><a href=#dom-workerglobalscope-location>location</a></code> attribute |
| 1875 |
|
|
represents an <span>absolute URL</span> that has the <span>same |
| 1876 |
|
|
origin</span> as the resulting <span>absolute URL</span>, then |
| 1877 |
|
|
run these substeps:</p> |
| 1878 |
|
|
|
| 1879 |
|
|
<ol><li><p>Let <var title="">worker global scope</var> be that |
| 1880 |
|
|
<code><a href=#sharedworkerglobalscope>SharedWorkerGlobalScope</a></code> object.</li> |
| 1881 |
|
|
|
| 1882 |
|
|
<li><p>If <var title="">worker global scope</var>'s <code title=dom-WorkerGlobalScope-location><a href=#dom-workerglobalscope-location>location</a></code> |
| 1883 |
|
|
attribute represents an <span>absolute URL</span> that is not |
| 1884 |
|
|
exactly equal to the resulting <span>absolute URL</span>, then |
| 1885 |
|
|
throw a <code>URL_MISMATCH_ERR</code> exception and abort all |
| 1886 |
|
|
these steps.</li> |
| 1887 |
|
|
|
| 1888 |
|
|
<li><p>Associate <var title="">worker</var> with <var title="">worker global scope</var>.</li> |
| 1889 |
|
|
|
| 1890 |
|
|
<li><p><span>Create a <code>MessagePort</code> object</span> |
| 1891 |
|
|
owned by <var title="">worker global scope</var>. Let this |
| 1892 |
|
|
be the <var title="">inside port</var>.</li> |
| 1893 |
|
|
|
| 1894 |
|
|
<li><p><span>Entangle</span> <var title="">outside port</var> |
| 1895 |
|
|
and <var title="">inside port</var>.</li> |
| 1896 |
|
|
|
| 1897 |
|
|
<li><p>Return <var title="">worker</var> and perform the next |
| 1898 |
|
|
step asynchronously.</li> |
| 1899 |
|
|
|
| 1900 |
|
|
<li><p>Create an event that uses the <code>MessageEvent</code> |
| 1901 |
|
|
interface, with the name <code title=event-connect>connect</code>, which does not bubble, is |
| 1902 |
|
|
not cancelable, has no default action, has a <code title=dom-MessageEvent-data>data</code> attribute whose value |
| 1903 |
|
|
is the empty string and has a <code title=dom-MessageEvent-ports>ports</code> attribute whose |
| 1904 |
|
|
value is an array containing only the newly created port, and |
| 1905 |
|
|
<span>queue a task</span> to dispatch the event at <var title="">worker global scope</var>.</li> |
| 1906 |
|
|
|
| 1907 |
|
|
<li> |
| 1908 |
|
|
|
| 1909 |
|
|
<p><a href="#add-a-document-to-the-worker's-documents" title="add a document to the worker's documents">Add to |
| 1910 |
|
|
<var title="">worker global scope</var>'s list of <span>the |
| 1911 |
|
|
worker's <code>Document</code>s</span></a> the |
| 1912 |
|
|
<code>Document</code> objects in <var title="">docs</var>.</p> |
| 1913 |
|
|
|
| 1914 |
|
|
</li> |
| 1915 |
|
|
|
| 1916 |
|
|
<li> |
| 1917 |
|
|
|
| 1918 |
|
|
<p>If the <span title="script's global scope">global |
| 1919 |
|
|
scope</span> of the <span title=concept-script>script</span> |
| 1920 |
|
|
that invoked the constructor is a |
| 1921 |
|
|
<code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object, add <var title="">worker global scope</var> to the list of <a href="#the-worker's-workers">the |
| 1922 |
|
|
worker's workers</a> of the <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> |
| 1923 |
|
|
object that is the <span title="script's global scope">global |
| 1924 |
|
|
scope</span> of the <span title=concept-script>script</span> |
| 1925 |
|
|
that invoked the constructor.</p> |
| 1926 |
|
|
|
| 1927 |
|
|
</li> |
| 1928 |
|
|
|
| 1929 |
|
|
<li><p>Abort all these steps.</li> |
| 1930 |
|
|
|
| 1931 |
|
|
</ol></li> |
| 1932 |
|
|
|
| 1933 |
|
|
<li><p><span>Create a new <code><a href=#sharedworkerglobalscope>SharedWorkerGlobalScope</a></code> |
| 1934 |
|
|
object</span>. Let <var title="">worker global scope</var> be |
| 1935 |
|
|
this new object.</li> |
| 1936 |
|
|
|
| 1937 |
|
|
<li><p>Associate <var title="">worker</var> with <var title="">worker global scope</var>.</li> |
| 1938 |
|
|
|
| 1939 |
|
|
<li><p>Set the <code title=dom-SharedWorkerGlobalScope-name><a href=#dom-sharedworkerglobalscope-name>name</a></code> attribute of |
| 1940 |
|
|
<var title="">worker global scope</var> to <var title="">name</var>.</li> |
| 1941 |
|
|
|
| 1942 |
|
|
<li><p><span>Create a <code>MessagePort</code> object</span> |
| 1943 |
|
|
owned by <var title="">worker global scope</var>. Let <var title="">inside port</var> be this new object.</li> |
| 1944 |
|
|
|
| 1945 |
|
|
<li><p><span>Entangle</span> <var title="">outside port</var> and |
| 1946 |
|
|
<var title="">inside port</var>.</li> |
| 1947 |
|
|
|
| 1948 |
|
|
</ol></li> |
| 1949 |
|
|
|
| 1950 |
|
|
<li><p>Return <var title="">worker</var> and perform the remaining |
| 1951 |
|
|
steps asynchronously.</li> |
| 1952 |
|
|
|
| 1953 |
|
|
<li><p>Create an event that uses the <code>MessageEvent</code> |
| 1954 |
|
|
interface, with the name <code title=event-connect>connect</code>, which does not bubble, is not |
| 1955 |
|
|
cancelable, has no default action, has a <code title=dom-MessageEvent-data>data</code> attribute whose value is |
| 1956 |
|
|
the empty string and has a <code title=dom-MessageEvent-ports>ports</code> attribute whose value |
| 1957 |
|
|
is an array containing only the newly created port, and <span>queue |
| 1958 |
|
|
a task</span> to dispatch the event at <var title="">worker global |
| 1959 |
|
|
scope</var>.</li> |
| 1960 |
|
|
|
| 1961 |
|
|
<li> |
| 1962 |
|
|
|
| 1963 |
|
|
<p><a href="#add-a-document-to-the-worker's-documents" title="add a document to the worker's documents">Add to |
| 1964 |
|
|
<var title="">worker global scope</var>'s list of <span>the |
| 1965 |
|
|
worker's <code>Document</code>s</span></a> the |
| 1966 |
|
|
<code>Document</code> objects in <var title="">docs</var>.</p> |
| 1967 |
|
|
|
| 1968 |
|
|
</li> |
| 1969 |
|
|
|
| 1970 |
|
|
<li> |
| 1971 |
|
|
|
| 1972 |
|
|
<p>If the <span title="script's global scope">global scope</span> |
| 1973 |
|
|
of the <span title=concept-script>script</span> that invoked the |
| 1974 |
|
|
constructor is a <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object, add <var title="">worker global scope</var> to the list of <a href="#the-worker's-workers">the |
| 1975 |
|
|
worker's workers</a> of the <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> |
| 1976 |
|
|
object that is the <span title="script's global scope">global |
| 1977 |
|
|
scope</span> of the <span title=concept-script>script</span> |
| 1978 |
|
|
that invoked the constructor.</p> |
| 1979 |
|
|
|
| 1980 |
|
|
</li> |
| 1981 |
|
|
|
| 1982 |
|
|
<li> |
| 1983 |
|
|
|
| 1984 |
|
|
<p><a href=#run-a-worker>Run a worker</a> for the resulting <span>absolute |
| 1985 |
|
|
URL</span>, with the <span>script browsing context</span> of the |
| 1986 |
|
|
script that invoked the method as the <var title="">owner browsing |
| 1987 |
|
|
context</var>, and with <var title="">worker global scope</var> as |
| 1988 |
|
|
the global scope.</p> |
| 1989 |
|
|
|
| 1990 |
|
|
</li> |
| 1991 |
|
|
|
| 1992 |
wakaba |
1.95 |
</ol><p>This constructor must be visible when the <span>script's global |
| 1993 |
|
|
scope</span> is either a <code>Window</code> object or an object |
| 1994 |
|
|
implementing the <code><a href=#workerutils>WorkerUtils</a></code> interface.</p> |
| 1995 |
|
|
|
| 1996 |
|
|
|
| 1997 |
|
|
|
| 1998 |
|
|
<h2 id=apis-available-to-workers><span class=secno>5 </span>APIs available to workers</h2> |
| 1999 |
wakaba |
1.82 |
|
| 2000 |
wakaba |
1.93 |
<pre class=idl>[NoInterfaceObject, ImplementedOn=WorkerGlobalScope, Supplemental] interface <dfn id=workerutils>WorkerUtils</dfn> { |
| 2001 |
wakaba |
1.82 |
void <a href=#dom-workerglobalscope-importscripts title=dom-WorkerGlobalScope-importScripts>importScripts</a>([Variadic] in DOMString urls); |
| 2002 |
|
|
readonly attribute <a href=#worker-navigator title=worker-Navigator>Navigator</a> <a href=#dom-worker-navigator title=dom-worker-navigator>navigator</a>; |
| 2003 |
|
|
};</pre> |
| 2004 |
|
|
|
| 2005 |
|
|
<p>Objects that implement the <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> |
| 2006 |
|
|
interface must also implement the <code><a href=#workerutils>WorkerUtils</a></code> |
| 2007 |
|
|
interface.</p> |
| 2008 |
|
|
|
| 2009 |
|
|
<p>Objects that implement the <code><a href=#workerutils>WorkerUtils</a></code> interface |
| 2010 |
|
|
must also implement the <code>WindowTimers</code> interface. (This |
| 2011 |
|
|
interface provides the <code title="">setTimeout()</code> method and |
| 2012 |
|
|
its friends.)</p><!-- XXX ref --> |
| 2013 |
|
|
|
| 2014 |
|
|
<!-- XXX ApplicationCache --> |
| 2015 |
|
|
|
| 2016 |
|
|
<!-- XXX debugging: void log(in DOMString s); // log to console --> |
| 2017 |
|
|
|
| 2018 |
|
|
<hr><p>The DOM APIs (<code>Node</code> objects, <code>Document</code> |
| 2019 |
|
|
objects, etc) are not available to workers in this version of this |
| 2020 |
|
|
specification.</p> |
| 2021 |
|
|
|
| 2022 |
|
|
|
| 2023 |
|
|
<h3 id=importing-scripts-and-libraries><span class=secno>5.1 </span>Importing scripts and libraries</h3> |
| 2024 |
|
|
|
| 2025 |
|
|
<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 |
| 2026 |
|
|
<code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object, the user agent must run the |
| 2027 |
|
|
following steps:</p> |
| 2028 |
|
|
|
| 2029 |
|
|
<ol><li><p>If there are no arguments, return without doing |
| 2030 |
|
|
anything. Abort these steps.</li> |
| 2031 |
|
|
|
| 2032 |
|
|
<li><p><span title="resolve a url">Resolve</span> each |
| 2033 |
|
|
argument.</li> |
| 2034 |
|
|
|
| 2035 |
|
|
<li><p>If any fail, throw a <code>SYNTAX_ERR</code> |
| 2036 |
|
|
exception.</li> |
| 2037 |
|
|
|
| 2038 |
|
|
<!-- |
| 2039 |
|
|
<li><p>If any of the resulting <span title="absolute URL">absolute |
| 2040 |
|
|
URLs</span> have an <span>origin</span> that is not the <span |
| 2041 |
|
|
title="same origin">same</span> as the origin of the script that |
| 2042 |
|
|
invoked the method, then throw a <span>security |
| 2043 |
|
|
exception</span>.</p></li> |
| 2044 |
|
|
--> |
| 2045 |
|
|
|
| 2046 |
|
|
<li> |
| 2047 |
|
|
|
| 2048 |
|
|
<p>Attempt to <span>fetch</span> each resource identified by the |
| 2049 |
|
|
resulting <span title="absolute URLs">absolute URL</span>.</p> |
| 2050 |
|
|
|
| 2051 |
|
|
</li> |
| 2052 |
|
|
|
| 2053 |
|
|
<li> |
| 2054 |
|
|
|
| 2055 |
|
|
<p>For each argument in turn, in the order given, starting with |
| 2056 |
|
|
the first one, run these substeps:</p> |
| 2057 |
|
|
|
| 2058 |
|
|
<ol><li> |
| 2059 |
|
|
|
| 2060 |
|
|
<p>Wait for the fetching attempt for the corresponding resource |
| 2061 |
|
|
to complete.</p> |
| 2062 |
|
|
|
| 2063 |
|
|
<p>If the fetching attempt failed, throw a |
| 2064 |
|
|
<code>NETWORK_ERR</code> exception and abort all these |
| 2065 |
|
|
steps.</p> |
| 2066 |
|
|
|
| 2067 |
|
|
<p>If the attempt succeeds, then <a href=#decode-a-script-resource title="decode a script |
| 2068 |
|
|
resource">decode the script resource</a> to obtain its <var title="">source</var>.</p> |
| 2069 |
|
|
|
| 2070 |
|
|
<p>Let <var title="">language</var> be JavaScript.</p> |
| 2071 |
|
|
|
| 2072 |
|
|
<p class=note>As with the worker's script, the script here is |
| 2073 |
|
|
always assumed to be JavaScript, regardless of the MIME |
| 2074 |
|
|
type.</p> <!-- XXX --> |
| 2075 |
|
|
|
| 2076 |
|
|
</li> |
| 2077 |
|
|
|
| 2078 |
|
|
<li> |
| 2079 |
|
|
|
| 2080 |
|
|
<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 |
| 2081 |
|
|
same global object, browsing context, character encoding, base |
| 2082 |
|
|
URL, and script group as the <span title=concept-script>script</span> that was created by the |
| 2083 |
|
|
worker's <a href=#run-a-worker>run a worker</a> algorithm.</p> |
| 2084 |
|
|
|
| 2085 |
|
|
<p>Let the newly created <span title=concept-script>script</span> run until it either |
| 2086 |
|
|
returns, fails to parse, fails to catch an exception, or gets |
| 2087 |
|
|
prematurely aborted by the "<a href=#kill-a-worker>kill a worker</a>" or |
| 2088 |
|
|
"<a href=#terminate-a-worker>terminate a worker</a>" algorithms defined above.</p> |
| 2089 |
|
|
|
| 2090 |
|
|
<p>If it failed to parse, then throw a |
| 2091 |
|
|
<code>SyntaxError</code><!-- XXX ref? --> exception and abort |
| 2092 |
|
|
all these steps.</p> |
| 2093 |
|
|
|
| 2094 |
|
|
<p>If an exception was raised or if the script was prematurely |
| 2095 |
|
|
aborted, then abort all these steps, letting the exception or |
| 2096 |
|
|
aborting continue to be processed by the script that called the |
| 2097 |
|
|
<code title=dom-WorkerGlobalScope-importScripts><a href=#dom-workerglobalscope-importscripts>importScripts()</a></code> |
| 2098 |
|
|
method.</p> |
| 2099 |
|
|
|
| 2100 |
|
|
<p>If the "<a href=#kill-a-worker>kill a worker</a>" or "<a href=#terminate-a-worker>terminate a |
| 2101 |
|
|
worker</a>" algorithms abort the script then abort all these |
| 2102 |
|
|
steps.</p> |
| 2103 |
|
|
|
| 2104 |
|
|
</li> |
| 2105 |
|
|
|
| 2106 |
|
|
</ol></li> |
| 2107 |
|
|
|
| 2108 |
|
|
</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> |
| 2109 |
|
|
|
| 2110 |
|
|
<p>The <dfn id=dom-worker-navigator title=dom-worker-navigator><code>navigator</code></dfn> attribute |
| 2111 |
|
|
of the <code><a href=#workerutils>WorkerUtils</a></code> interface must return an instance of |
| 2112 |
|
|
the <code title=worker-Navigator><a href=#worker-navigator>Navigator</a></code> interface, which |
| 2113 |
|
|
represents the identity and state of the user agent (the |
| 2114 |
|
|
client):</p> |
| 2115 |
|
|
|
| 2116 |
|
|
<pre class=idl>interface <dfn id=worker-navigator title=worker-Navigator>Navigator</dfn> { |
| 2117 |
|
|
// objects implementing this interface also implement the interfaces listed below |
| 2118 |
|
|
};</pre> |
| 2119 |
|
|
|
| 2120 |
|
|
<p>Objects implementing the <code title=worker-Navigator><a href=#worker-navigator>Navigator</a></code> interface must also |
| 2121 |
|
|
implement the <span>NavigatorID</span> and |
| 2122 |
wakaba |
1.84 |
<span>NavigatorOnLine</span> interfaces. <a href=#refsHTML5>[HTML5]</a></p> |
| 2123 |
wakaba |
1.82 |
|
| 2124 |
|
|
<p class=note>The <code title=worker-Navigator><a href=#worker-navigator>Navigator</a></code> |
| 2125 |
|
|
interface defined in this specification is different than the one |
| 2126 |
wakaba |
1.84 |
defined in the HTML specification.</p> |
| 2127 |
wakaba |
1.82 |
|
| 2128 |
|
|
|
| 2129 |
|
|
|
| 2130 |
|
|
<h3 id=apis-defined-in-other-specifications><span class=secno>5.3 </span>APIs defined in other specifications</h3> |
| 2131 |
|
|
|
| 2132 |
|
|
<p>The <code title=dom-opendatabase>openDatabase()</code> and |
| 2133 |
|
|
<code title=dom-opendatabase-sync>openDatabaseSync()</code> |
| 2134 |
|
|
methods are defined in the Web Storage specification. <a href=#refsWEBSTORAGE>[WEBSTORAGE]</a></p> |
| 2135 |
|
|
|
| 2136 |
|
|
|
| 2137 |
|
|
|
| 2138 |
|
|
<h3 id=interface-objects-and-constructors><span class=secno>5.4 </span>Interface objects and constructors</h3> |
| 2139 |
|
|
|
| 2140 |
|
|
<p>There must be no interface objects and constructors available in |
| 2141 |
|
|
the global scope of scripts whose <span>script execution |
| 2142 |
|
|
context</span> is a <code><a href=#workerglobalscope>WorkerGlobalScope</a></code> object except for |
| 2143 |
|
|
the following:</p> |
| 2144 |
|
|
|
| 2145 |
|
|
<ul><li><p><code>XMLHttpRequest</code> and all interface objects and |
| 2146 |
|
|
constructors defined by the XMLHttpRequest specifications, except |
| 2147 |
|
|
that the <span>document response entity body</span> must always be |
| 2148 |
|
|
null. <a href=#refsXHR>[XHR]</a></li> |
| 2149 |
|
|
|
| 2150 |
|
|
<li><p>The <code>WebSocket</code> interface object and |
| 2151 |
|
|
constructor. <a href=#refsWEBSOCKET>[WEBSOCKET]</a></li> |
| 2152 |
|
|
|
| 2153 |
|
|
<li><p>The <code>EventSource</code> interface object and |
| 2154 |
|
|
constructor. <a href=#refsEVENTSOURCE>[EVENTSOURCE]</a></li> |
| 2155 |
|
|
|
| 2156 |
|
|
<li><p>The <code>MessageChannel</code> interface object and |
| 2157 |
|
|
constructor. <a href=#refsHTML5>[HTML5]</a></li> |
| 2158 |
|
|
|
| 2159 |
|
|
<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> |
| 2160 |
|
|
|
| 2161 |
|
|
</ul><h3 id=worker-locations><span class=secno>5.5 </span>Worker locations</h3> |
| 2162 |
|
|
|
| 2163 |
|
|
<pre class=idl>interface <dfn id=workerlocation>WorkerLocation</dfn> { |
| 2164 |
|
|
readonly attribute DOMString <a href=#dom-workerlocation-href title=dom-WorkerLocation-href>href</a>; |
| 2165 |
|
|
readonly attribute DOMString <a href=#dom-workerlocation-protocol title=dom-WorkerLocation-protocol>protocol</a>; |
| 2166 |
|
|
readonly attribute DOMString <a href=#dom-workerlocation-host title=dom-WorkerLocation-host>host</a>; |
| 2167 |
|
|
readonly attribute DOMString <a href=#dom-workerlocation-hostname title=dom-WorkerLocation-hostname>hostname</a>; |
| 2168 |
|
|
readonly attribute DOMString <a href=#dom-workerlocation-port title=dom-WorkerLocation-port>port</a>; |
| 2169 |
|
|
readonly attribute DOMString <a href=#dom-workerlocation-pathname title=dom-WorkerLocation-pathname>pathname</a>; |
| 2170 |
|
|
readonly attribute DOMString <a href=#dom-workerlocation-search title=dom-WorkerLocation-search>search</a>; |
| 2171 |
|
|
readonly attribute DOMString <a href=#dom-workerlocation-hash title=dom-WorkerLocation-hash>hash</a>; |
| 2172 |
|
|
};</pre> |
| 2173 |
|
|
|
| 2174 |
|
|
<p>A <code><a href=#workerlocation>WorkerLocation</a></code> object represents an <span>absolute |
| 2175 |
|
|
URL</span> set at its creation.</p> |
| 2176 |
|
|
|
| 2177 |
|
|
<p>The <dfn id=dom-workerlocation-href title=dom-WorkerLocation-href><code>href</code></dfn> |
| 2178 |
|
|
attribute must return the <span>absolute URL</span> that the object |
| 2179 |
|
|
represents.</p> |
| 2180 |
|
|
|
| 2181 |
|
|
<p>The <code><a href=#workerlocation>WorkerLocation</a></code> interface also has the complement |
| 2182 |
|
|
of <span>URL decomposition attributes</span>, <dfn id=dom-workerlocation-protocol title=dom-WorkerLocation-protocol><code>protocol</code></dfn>, |
| 2183 |
|
|
<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>, |
| 2184 |
|
|
<dfn id=dom-workerlocation-pathname title=dom-WorkerLocation-pathname><code>pathname</code></dfn>, |
| 2185 |
|
|
<dfn id=dom-workerlocation-search title=dom-WorkerLocation-search><code>search</code></dfn>, |
| 2186 |
|
|
and <dfn id=dom-workerlocation-hash title=dom-WorkerLocation-hash><code>hash</code></dfn>. These must |
| 2187 |
|
|
follow the rules given for URL decomposition attributes, with the |
| 2188 |
|
|
<span title=concept-uda-input>input</span> being the |
| 2189 |
|
|
<span>absolute URL</span> that the object represents (same as the |
| 2190 |
|
|
<code title=dom-WorkerLocation-href><a href=#dom-workerlocation-href>href</a></code> attribute), and |
| 2191 |
|
|
the <span title=concept-uda-setter>common setter action</span> |
| 2192 |
|
|
being a no-op, since the attributes are defined to be readonly. <a href=#refsHTML5>[HTML5]</a></p> |
| 2193 |
|
|
|
| 2194 |
|
|
|
| 2195 |
|
|
|
| 2196 |
|
|
|
| 2197 |
|
|
<h2 class=no-num id=references>References</h2> |
| 2198 |
|
|
|
| 2199 |
|
|
<p class=big-issue>This section will be written in a future |
| 2200 |
|
|
draft.<!--XXX--></p> |
| 2201 |
|
|
|
| 2202 |
|
|
|
| 2203 |
|
|
<h2 class=no-num id=acknowledgements>Acknowledgements</h2> <!-- ACKS --> |
| 2204 |
|
|
|
| 2205 |
|
|
<p>Thanks to |
| 2206 |
|
|
|
| 2207 |
|
|
Aaron Boodman, |
| 2208 |
|
|
Алексей Проскуряков (Alexey Proskuryakov), |
| 2209 |
|
|
Anne van Kesteren, |
| 2210 |
|
|
Ben Turner, |
| 2211 |
|
|
Dmitry Titov, |
| 2212 |
|
|
Drew Wilson, |
| 2213 |
|
|
Jeremy Orlow, |
| 2214 |
|
|
Jonas Sicking, |
| 2215 |
|
|
Justin James, |
| 2216 |
|
|
Kevin Hakanson, |
| 2217 |
|
|
Maciej Stachowiak, |
| 2218 |
|
|
Michael Nordman, |
| 2219 |
|
|
Mike Smith, |
| 2220 |
|
|
|
| 2221 |
|
|
and |
| 2222 |
|
|
|
| 2223 |
|
|
Philip Taylor |
| 2224 |
|
|
|
| 2225 |
|
|
for their useful and substantial comments.</p> |
| 2226 |
|
|
|
| 2227 |
|
|
<p>Huge thanks to the whole Gears team, who pioneered this |
| 2228 |
|
|
technology and whose experience has been a huge influence on this |
| 2229 |
|
|
specification.</p> |
| 2230 |
|
|
|
| 2231 |
|
|
|