Annotation of html5/workers/Overview.html, revision 1.346
1.327 ihickson 1: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html lang="en-US-x-Hixie"><title>Web Workers</title><style type="text/css">
1.82 ihickson 2: pre { margin-left: 2em; white-space: pre-wrap; }
3: h2 { margin: 3em 0 1em 0; }
4: h3 { margin: 2.5em 0 1em 0; }
5: h4 { margin: 2.5em 0 0.75em 0; }
6: h5, h6 { margin: 2.5em 0 1em; }
7: h1 + h2, h1 + h2 + h2 { margin: 0.75em 0 0.75em; }
8: h2 + h3, h3 + h4, h4 + h5, h5 + h6 { margin-top: 0.5em; }
9: p { margin: 1em 0; }
10: hr:not(.top) { display: block; background: none; border: none; padding: 0; margin: 2em 0; height: auto; }
11: dl, dd { margin-top: 0; margin-bottom: 0; }
12: dt { margin-top: 0.75em; margin-bottom: 0.25em; clear: left; }
13: dt + dt { margin-top: 0; }
14: dd dt { margin-top: 0.25em; margin-bottom: 0; }
15: dd p { margin-top: 0; }
16: dd dl + p { margin-top: 1em; }
17: dd table + p { margin-top: 1em; }
18: p + * > li, dd li { margin: 1em 0; }
19: dt, dfn { font-weight: bold; font-style: normal; }
1.300 ihickson 20: i, em { font-style: italic; }
1.82 ihickson 21: dt dfn { font-style: italic; }
22: pre, code { font-size: inherit; font-family: monospace; font-variant: normal; }
23: pre strong { color: black; font: inherit; font-weight: bold; background: yellow; }
24: pre em { font-weight: bolder; font-style: normal; }
1.89 ihickson 25: @media screen { code { color: orangered; } code :link, code :visited { color: inherit; } }
1.82 ihickson 26: var sub { vertical-align: bottom; font-size: smaller; position: relative; top: 0.1em; }
27: table { border-collapse: collapse; border-style: hidden hidden none hidden; }
1.249 ihickson 28: table thead, table tbody { border-bottom: solid; }
1.82 ihickson 29: table tbody th:first-child { border-left: solid; }
1.180 ihickson 30: table tbody th { text-align: left; }
1.82 ihickson 31: table td, table th { border-left: solid; border-right: solid; border-bottom: solid thin; vertical-align: top; padding: 0.2em; }
32: blockquote { margin: 0 0 0 2em; border: 0; padding: 0; font-style: italic; }
33:
34: .bad, .bad *:not(.XXX) { color: gray; border-color: gray; background: transparent; }
35: .matrix, .matrix td { border: none; text-align: right; }
36: .matrix { margin-left: 2em; }
37: .dice-example { border-collapse: collapse; border-style: hidden solid solid hidden; border-width: thin; margin-left: 3em; }
38: .dice-example caption { width: 30em; font-size: smaller; font-style: italic; padding: 0.75em 0; text-align: left; }
39: .dice-example td, .dice-example th { border: solid thin; width: 1.35em; height: 1.05em; text-align: center; padding: 0; }
40:
41: .toc dfn, h1 dfn, h2 dfn, h3 dfn, h4 dfn, h5 dfn, h6 dfn { font: inherit; }
1.305 ihickson 42: img.extra, p.overview { float: right; }
1.304 ihickson 43: pre.idl { border: solid thin; background: #EEEEEE; color: black; padding: 0.5em 1em; position: relative; }
1.82 ihickson 44: pre.idl :link, pre.idl :visited { color: inherit; background: transparent; }
1.304 ihickson 45: pre.idl::before { content: "IDL"; font: bold small sans-serif; padding: 0.5em; background: white; position: absolute; top: 0; margin: -1px 0 0 -4em; width: 1.5em; border: thin solid; border-radius: 0 0 0 0.5em }
1.82 ihickson 46: pre.css { border: solid thin; background: #FFFFEE; color: black; padding: 0.5em 1em; }
47: pre.css:first-line { color: #AAAA50; }
1.231 ihickson 48: dl.domintro { color: green; margin: 2em 0 2em 2em; padding: 0.5em 1em; border: none; background: #DDFFDD; }
1.82 ihickson 49: hr + dl.domintro, div.impl + dl.domintro { margin-top: 2.5em; margin-bottom: 1.5em; }
50: dl.domintro dt, dl.domintro dt * { color: black; text-decoration: none; }
51: dl.domintro dd { margin: 0.5em 0 1em 2em; padding: 0; }
52: dl.domintro dd p { margin: 0.5em 0; }
1.310 ihickson 53: dl.domintro:before { display: table; margin: -1em -0.5em -0.5em auto; width: auto; content: 'This box is non-normative. Implementation requirements are given below this box.'; color: black; font-style: italic; border: solid 2px; background: white; padding: 0 0.25em; }
1.82 ihickson 54: dl.switch { padding-left: 2em; }
55: dl.switch > dt { text-indent: -1.5em; }
56: dl.switch > dt:before { content: '\21AA'; padding: 0 0.5em 0 0; display: inline-block; width: 1em; text-align: right; line-height: 0.5em; }
1.121 ihickson 57: dl.triple { padding: 0 0 0 1em; }
58: dl.triple dt, dl.triple dd { margin: 0; display: inline }
59: dl.triple dt:after { content: ':'; }
60: dl.triple dd:after { content: '\A'; white-space: pre; }
1.82 ihickson 61: .diff-old { text-decoration: line-through; color: silver; background: transparent; }
62: .diff-chg, .diff-new { text-decoration: underline; color: green; background: transparent; }
63: a .diff-new { border-bottom: 1px blue solid; }
64:
65: h2 { page-break-before: always; }
1.139 ihickson 66: h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
1.82 ihickson 67: h1 + h2, hr + h2.no-toc { page-break-before: auto; }
68:
1.267 ihickson 69: p > span:not([title=""]):not([class="XXX"]):not([class="impl"]):not([class="note"]),
70: li > span:not([title=""]):not([class="XXX"]):not([class="impl"]):not([class="note"]), { border-bottom: solid #9999CC; }
1.82 ihickson 71:
72: div.head { margin: 0 0 1em; padding: 1em 0 0 0; }
73: div.head p { margin: 0; }
74: div.head h1 { margin: 0; }
75: div.head .logo { float: right; margin: 0 1em; }
76: div.head .logo img { border: none } /* remove border from top image */
77: div.head dl { margin: 1em 0; }
1.212 ihickson 78: div.head p.copyright, div.head p.alt { font-size: x-small; font-style: oblique; margin: 0; }
1.82 ihickson 79:
80: body > .toc > li { margin-top: 1em; margin-bottom: 1em; }
81: body > .toc.brief > li { margin-top: 0.35em; margin-bottom: 0.35em; }
82: body > .toc > li > * { margin-bottom: 0.5em; }
83: body > .toc > li > * > li > * { margin-bottom: 0.25em; }
84: .toc, .toc li { list-style: none; }
85:
86: .brief { margin-top: 1em; margin-bottom: 1em; line-height: 1.1; }
87: .brief li { margin: 0; padding: 0; }
88: .brief li p { margin: 0; padding: 0; }
89:
1.137 ihickson 90: .category-list { margin-top: -0.75em; margin-bottom: 1em; line-height: 1.5; }
91: .category-list::before { content: '\21D2\A0'; font-size: 1.2em; font-weight: 900; }
92: .category-list li { display: inline; }
93: .category-list li:not(:last-child)::after { content: ', '; }
94: .category-list li > span, .category-list li > a { text-transform: lowercase; }
95: .category-list li * { text-transform: none; } /* don't affect <code> nested in <a> */
96:
1.82 ihickson 97: .XXX { color: #E50000; background: white; border: solid red; padding: 0.5em; margin: 1em 0; }
98: .XXX > :first-child { margin-top: 0; }
99: p .XXX { line-height: 3em; }
1.158 ihickson 100: .annotation { border: solid thin black; background: #0C479D; color: white; position: relative; margin: 8px 0 20px 0; }
101: .annotation:before { position: absolute; left: 0; top: 0; width: 100%; height: 100%; margin: 6px -6px -6px 6px; background: #333333; z-index: -1; content: ''; }
102: .annotation :link, .annotation :visited { color: inherit; }
103: .annotation :link:hover, .annotation :visited:hover { background: transparent; }
104: .annotation span { border: none ! important; }
1.82 ihickson 105: .note { color: green; background: transparent; font-family: sans-serif; }
106: .warning { color: red; background: transparent; }
107: .note, .warning { font-weight: bolder; font-style: italic; }
1.300 ihickson 108: .note em, .warning em, .note i, .warning i { font-style: normal; }
1.82 ihickson 109: p.note, div.note { padding: 0.5em 2em; }
110: span.note { padding: 0 2em; }
111: .note p:first-child, .warning p:first-child { margin-top: 0; }
112: .note p:last-child, .warning p:last-child { margin-bottom: 0; }
113: .warning:before { font-style: normal; }
114: p.note:before { content: 'Note: '; }
115: p.warning:before { content: '\26A0 Warning! '; }
116:
117: .bookkeeping:before { display: block; content: 'Bookkeeping details'; font-weight: bolder; font-style: italic; }
118: .bookkeeping { font-size: 0.8em; margin: 2em 0; }
119: .bookkeeping p { margin: 0.5em 2em; display: list-item; list-style: square; }
1.262 ihickson 120: .bookkeeping dt { margin: 0.5em 2em 0; }
121: .bookkeeping dd { margin: 0 3em 0.5em; }
1.82 ihickson 122:
123: h4 { position: relative; z-index: 3; }
124: h4 + .element, h4 + div + .element { margin-top: -2.5em; padding-top: 2em; }
125: .element {
1.88 ihickson 126: background: #EEEEFF;
1.82 ihickson 127: color: black;
128: margin: 0 0 1em 0.15em;
129: padding: 0 1em 0.25em 0.75em;
1.88 ihickson 130: border-left: solid #9999FF 0.25em;
1.82 ihickson 131: position: relative;
132: z-index: 1;
133: }
134: .element:before {
135: position: absolute;
136: z-index: 2;
137: top: 0;
138: left: -1.15em;
139: height: 2em;
140: width: 0.9em;
1.88 ihickson 141: background: #EEEEFF;
1.82 ihickson 142: content: ' ';
143: border-style: none none solid solid;
1.88 ihickson 144: border-color: #9999FF;
1.82 ihickson 145: border-width: 0.25em;
146: }
147:
1.156 ihickson 148: .example { display: block; color: #222222; background: #FCFCFC; border-left: double; margin-left: 2em; padding-left: 1em; }
149: td > .example:only-child { margin: 0 0 0 0.1em; }
1.82 ihickson 150:
1.131 ihickson 151: ul.domTree, ul.domTree ul { padding: 0 0 0 1em; margin: 0; }
152: ul.domTree li { padding: 0; margin: 0; list-style: none; position: relative; }
153: ul.domTree li li { list-style: none; }
154: ul.domTree li:first-child::before { position: absolute; top: 0; height: 0.6em; left: -0.75em; width: 0.5em; border-style: none none solid solid; content: ''; border-width: 0.1em; }
155: ul.domTree li:not(:last-child)::after { position: absolute; top: 0; bottom: -0.6em; left: -0.75em; width: 0.5em; border-style: none none solid solid; content: ''; border-width: 0.1em; }
156: ul.domTree span { font-style: italic; font-family: serif; }
157: ul.domTree .t1 code { color: purple; font-weight: bold; }
158: ul.domTree .t2 { font-style: normal; font-family: monospace; }
159: ul.domTree .t2 .name { color: black; font-weight: bold; }
160: ul.domTree .t2 .value { color: blue; font-weight: normal; }
161: ul.domTree .t3 code, .domTree .t4 code, .domTree .t5 code { color: gray; }
162: ul.domTree .t7 code, .domTree .t8 code { color: green; }
163: ul.domTree .t10 code { color: teal; }
164:
1.225 ihickson 165: body.dfnEnabled dfn { cursor: pointer; }
166: .dfnPanel {
167: display: inline;
168: position: absolute;
169: z-index: 10;
170: height: auto;
171: width: auto;
172: padding: 0.5em 0.75em;
173: font: small sans-serif, Droid Sans Fallback;
174: background: #DDDDDD;
175: color: black;
176: border: outset 0.2em;
177: }
178: .dfnPanel * { margin: 0; padding: 0; font: inherit; text-indent: 0; }
179: .dfnPanel :link, .dfnPanel :visited { color: black; }
180: .dfnPanel p { font-weight: bolder; }
181: .dfnPanel * + p { margin-top: 0.25em; }
182: .dfnPanel li { list-style-position: inside; }
183:
1.207 ihickson 184: #configUI { position: absolute; z-index: 20; top: 10em; right: 1em; width: 11em; font-size: small; }
185: #configUI p { margin: 0.5em 0; padding: 0.3em; background: #EEEEEE; color: black; border: inset thin; }
186: #configUI p label { display: block; }
187: #configUI #updateUI, #configUI .loginUI { text-align: center; }
188: #configUI input[type=button] { display: block; margin: auto; }
1.260 ihickson 189:
1.268 ihickson 190: fieldset { margin: 1em; padding: 0.5em 1em; }
191: fieldset > legend + * { margin-top: 0; }
1.266 ihickson 192: fieldset > :last-child { margin-bottom: 0; }
1.268 ihickson 193: fieldset p { margin: 0.5em 0; }
1.266 ihickson 194:
1.329 ihickson 195: </style><link href="http://www.w3.org/StyleSheets/TR/W3C-ED" rel="stylesheet" type="text/css"><meta content="noindex" name="robots"><script type="text/javascript">
1.271 ihickson 196: function getCookie(name) {
197: var params = location.search.substr(1).split("&");
198: for (var index = 0; index < params.length; index++) {
199: if (params[index] == name)
200: return "1";
201: var data = params[index].split("=");
202: if (data[0] == name)
203: return unescape(data[1]);
204: }
205: var cookies = document.cookie.split("; ");
206: for (var index = 0; index < cookies.length; index++) {
207: var data = cookies[index].split("=");
208: if (data[0] == name)
209: return unescape(data[1]);
210: }
211: return null;
212: }
1.327 ihickson 213: </script><body>
214: <div class="head" id="head">
1.115 ihickson 215: <p><a href="http://www.w3.org/"><img alt="W3C" height="48" src="http://www.w3.org/Icons/w3c_home" width="72"></a></p>
1.271 ihickson 216:
1.54 ihickson 217: <h1>Web Workers</h1>
1.281 ihickson 218:
1.346 ! ihickson 219: <h2 class="no-num no-toc" id="editor-s-draft-25-october-2012">Editor's Draft 25 October 2012</h2>
1.218 ihickson 220: <dl><dt>Latest Published Version:</dt>
1.115 ihickson 221: <dd><a href="http://www.w3.org/TR/workers/">http://www.w3.org/TR/workers/</a></dd>
1.109 ihickson 222: <dt>Latest Editor's Draft:</dt>
1.260 ihickson 223: <dd><a class="latest-link" href="http://dev.w3.org/html5/workers/">http://dev.w3.org/html5/workers/</a></dd>
1.284 ihickson 224:
1.318 ihickson 225:
1.2 ihickson 226: <dt>Previous Versions:</dt>
1.279 ihickson 227: <dd><a href="http://www.w3.org/TR/2011/WD-workers-20110310/">http://www.w3.org/TR/2011/WD-workers-20110310/</a></dd>
228: <dd><a href="http://www.w3.org/TR/2011/WD-workers-20110208/">http://www.w3.org/TR/2011/WD-workers-20110208/</a></dd>
1.198 ihickson 229: <dd><a href="http://www.w3.org/TR/2009/WD-workers-20091029/">http://www.w3.org/TR/2009/WD-workers-20091029/</a></dd>
1.279 ihickson 230: <dd><a href="http://www.w3.org/TR/2009/WD-workers-20090423/">http://www.w3.org/TR/2009/WD-workers-20090423/</a></dd>
1.117 ihickson 231: <!-- :ZZZ -->
1.271 ihickson 232: <dt>Editor:</dt>
1.115 ihickson 233: <dd><a href="mailto:ian@hixie.ch">Ian Hickson</a>, Google, Inc.</dd>
1.155 ihickson 234: </dl><p class="copyright"><a href="http://www.w3.org/Consortium/Legal/ipr-notice#Copyright">Copyright</a>
1.328 ihickson 235: © 2012 <a href="http://www.w3.org/"><abbr title="World Wide
1.155 ihickson 236: Web Consortium">W3C</abbr></a><sup>®</sup> (<a href="http://www.csail.mit.edu/"><abbr title="Massachusetts
1.297 ihickson 237: Institute of Technology">MIT</abbr></a>, <a href="http://www.ercim.eu/"><abbr title="European Research
1.115 ihickson 238: Consortium for Informatics and Mathematics">ERCIM</abbr></a>, <a href="http://www.keio.ac.jp/">Keio</a>), All Rights Reserved. W3C
239: <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Legal_Disclaimer">liability</a>,
240: <a href="http://www.w3.org/Consortium/Legal/ipr-notice#W3C_Trademarks">trademark</a>
241: and <a href="http://www.w3.org/Consortium/Legal/copyright-documents">document
1.81 ihickson 242: use</a> rules apply.</p>
1.201 ihickson 243:
1.254 ihickson 244:
1.252 ihickson 245: <!-- UNDER NO CIRCUMSTANCES IS THE FOLLOWING PARAGRAPH TO BE REMOVED OR EDITED WITHOUT TALKING TO IAN FIRST -->
1.255 ihickson 246: <p class="alt">The bulk of the text of this specification is also
1.254 ihickson 247: available in the WHATWG <a href="http://www.whatwg.org/specs/web-apps/current-work/complete.html#workers">Web Applications 1.0</a> specification, under a license that permits
248: reuse of the specification text.</p>
1.252 ihickson 249: <!-- UNDER NO CIRCUMSTANCES IS THE PRECEDING PARAGRAPH TO BE REMOVED OR EDITED WITHOUT TALKING TO IAN FIRST -->
250:
1.254 ihickson 251:
1.327 ihickson 252: </div>
253:
254: <hr class="top"><h2 class="no-num no-toc" id="abstract">Abstract</h2>
255:
256: <p>This specification defines an API that allows Web application
1.81 ihickson 257: authors to spawn background workers running scripts in parallel to
258: their main page. This allows for thread-like operation with
1.327 ihickson 259: message-passing as the coordination mechanism.</p>
260:
261: <h2 class="no-num no-toc" id="status-of-this-document">Status of This document</h2>
262:
263:
264:
265:
266: <p><em>This section describes the status of this document at the
1.81 ihickson 267: time of its publication. Other documents may supersede this
1.297 ihickson 268: document. A list of current W3C publications and the
269:
270: most recently formally published <!-- DO NOT CHANGE THIS BACK TO THE STANDARD BOILERPLATE, AS IT IS INACCURATE -->
271:
272: revision of this technical report can be found in the <a href="http://www.w3.org/TR/">W3C technical reports index</a> at
1.327 ihickson 273: http://www.w3.org/TR/.</em></p>
274:
275:
276:
277:
1.345 ihickson 278: <p>If you wish to make comments regarding this document, you can
1.327 ihickson 279: enter feedback using this form:</p>
280:
281: <form action="http://www.whatwg.org/specs/web-apps/current-work/file-spam.cgi" method="post">
1.271 ihickson 282: <fieldset><legend>Feedback Comments</legend>
283: <input name="id" type="hidden" value="top"><input name="component" type="hidden" value="Web Workers (editor: Ian Hickson)"><input name="response" type="hidden" value="html"><p><label for="feedbackBox">Please enter your feedback, carefully
284: indicating the title of the section for which you are submitting
285: feedback, quoting the text that's wrong today if appropriate. If
286: you're suggesting a new feature, it's really important to say
287: <em>what</em> the problem you're trying to solve is. That's more
288: important than the solution, in fact.</label></p>
289: <p><textarea cols="79" id="feedbackBox" name="text" rows="10"></textarea></p>
290: <p class="note">Please don't use section numbers as these tend to
291: change rapidly and make your feedback harder to understand.</p>
292: <script type="text/javascript">
1.287 ihickson 293: function checkFeedbackForm(form) {
294: if (form.elements.text.value.match(/^ *</)) {
295: alert('Please don\'t start your feedback with an angle bracket, instead explain what topic your feedback is about first.');
296: return true;
297: } else if (form.elements.text.value.match(/ [^ ]+ [^ ]+ [^ ]+ [^ ]+ /)) {
298: if (form.elements.text.value.match(/^Please enter your feedback, carefully/)) {
299: alert('Please enter your feedback, explaining what is wrong, and without repeating the instructions. Thanks!');
300: return true;
301: } else if (form.elements.text.value.match(/ [^ ]+ [^ ]+ [^ ]+ [^ ]+ /)) {
302: form.action = "http://www.whatwg.org/specs/web-apps/current-work/file-bug.cgi";
303: return true;
304: } else {
305: alert('Please include significantly more detail about exactly what problem you are trying to solve.');
306: return false;
307: }
308: }
309: }
1.271 ihickson 310: </script><p>
1.277 ihickson 311: <input onclick="return checkFeedbackForm(form)" type="submit" value="Submit feedback"><small>(Note: Your IP address and user agent will be publicly recorded for spam prevention purposes.)</small>
1.271 ihickson 312: </p>
1.327 ihickson 313: </fieldset></form>
314:
315:
316: <p>You can also e-mail feedback to <a href="mailto:public-webapps@w3.org">public-webapps@w3.org</a> (<a href="mailto:public-webapps-request@w3.org?subject=subscribe">subscribe</a>,
1.271 ihickson 317: <a href="http://lists.w3.org/Archives/Public/public-webapps/">archives</a>),
1.115 ihickson 318: or <a href="mailto:whatwg@whatwg.org">whatwg@whatwg.org</a> (<a href="http://lists.whatwg.org/listinfo.cgi/whatwg-whatwg.org">subscribe</a>,
319: <a href="http://lists.whatwg.org/pipermail/whatwg-whatwg.org/">archives</a>).
1.327 ihickson 320: All feedback is welcome.</p>
321:
322:
323: <p>Implementors should be aware that this specification is not
1.81 ihickson 324: stable. <strong>Implementors who are not taking part in the
325: discussions are likely to find the specification changing out from
326: under them in incompatible ways.</strong> Vendors interested in
327: implementing this specification before it eventually reaches the
328: Candidate Recommendation stage should join the aforementioned
1.327 ihickson 329: mailing lists and take part in the discussions.</p>
330:
331: <div id="multipage-common">
332: </div>
333:
334: <p>The latest
1.271 ihickson 335: stable version of the editor's draft of this specification is always
336: available on <a href="http://dev.w3.org/html5/workers/">the W3C CVS server</a>
337: and in the <a href="http://svn.whatwg.org/webapps/">WHATWG
338: Subversion repository</a>. The <a href="http://www.whatwg.org/specs/web-apps/current-work/complete.html">latest
339: editor's working copy</a> (which may contain unfinished text in the
340: process of being prepared) contains the latest draft text of this
341: specification (amongst others). For more details, please see the <a href="http://wiki.whatwg.org/wiki/FAQ#What_are_the_various_versions_of_the_spec.3F">WHATWG
1.327 ihickson 342: FAQ</a>.</p>
343:
344: <p>Notifications of changes to this specification are sent along
1.271 ihickson 345: with notifications of changes to related specifications using the
1.327 ihickson 346: following mechanisms:</p>
347: <dl><dt>E-mail notifications of changes</dt>
1.271 ihickson 348: <dd>Commit-Watchers mailing list (complete source diffs): <a href="http://lists.whatwg.org/listinfo.cgi/commit-watchers-whatwg.org">http://lists.whatwg.org/listinfo.cgi/commit-watchers-whatwg.org</a></dd>
349: <dt>Browsable version-control record of all changes:</dt>
350: <dd>CVSWeb interface with side-by-side diffs: <a href="http://dev.w3.org/cvsweb/html5/">http://dev.w3.org/cvsweb/html5/</a></dd>
351: <dd>Annotated summary with unified diffs: <a href="http://html5.org/tools/web-apps-tracker">http://html5.org/tools/web-apps-tracker</a></dd>
352: <dd>Raw Subversion interface: <code>svn checkout http://svn.whatwg.org/webapps/</code></dd>
353: </dl><p>The W3C <a href="http://www.w3.org/2008/webapps/">Web Applications
1.81 ihickson 354: Working Group</a> is the W3C working group responsible for this
355: specification's progress along the W3C Recommendation track.
1.346 ! ihickson 356: This specification is the 25 October 2012 Editor's Draft.
1.327 ihickson 357: </p>
358:
359:
360:
361: <p>This document was produced by a group operating under the <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/">5
1.115 ihickson 362: February 2004 W3C Patent Policy</a>. W3C maintains a <a href="http://www.w3.org/2004/01/pp-impl/42538/status" rel="disclosure">public list of
1.81 ihickson 363: any patent disclosures</a> made in connection with the deliverables
364: of the group; that page also includes instructions for disclosing a
365: patent. An individual who has actual knowledge of a patent which the
1.115 ihickson 366: individual believes contains <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#def-essential">Essential
367: Claim(s)</a> must disclose the information in accordance with <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#sec-Disclosure">section
1.327 ihickson 368: 6 of the W3C Patent Policy</a>.</p>
369:
370:
371: <h2 class="no-num no-toc" id="contents">Table of Contents</h2>
372:
1.318 ihickson 373:
1.115 ihickson 374: <ol class="toc">
375: <li><a href="#introduction"><span class="secno">1 </span>Introduction</a>
1.81 ihickson 376: <ol>
1.115 ihickson 377: <li><a href="#scope"><span class="secno">1.1 </span>Scope</a></li>
1.303 ihickson 378: <li><a href="#examples"><span class="secno">1.2 </span>Examples</a>
1.81 ihickson 379: <ol>
1.115 ihickson 380: <li><a href="#a-background-number-crunching-worker"><span class="secno">1.2.1 </span>A background number-crunching worker</a></li>
1.323 ihickson 381: <li><a href="#worker-used-for-background-i-o"><span class="secno">1.2.2 </span>Worker used for background I/O</a></li>
382: <li><a href="#shared-workers-introduction"><span class="secno">1.2.3 </span>Shared workers introduction</a></li>
383: <li><a href="#shared-state-using-a-shared-worker"><span class="secno">1.2.4 </span>Shared state using a shared worker</a></li>
384: <li><a href="#delegation"><span class="secno">1.2.5 </span>Delegation</a></ol></li>
1.303 ihickson 385: <li><a href="#tutorials"><span class="secno">1.3 </span>Tutorials</a>
386: <ol>
387: <li><a href="#creating-a-dedicated-worker"><span class="secno">1.3.1 </span>Creating a dedicated worker</a></li>
388: <li><a href="#communicating-with-a-dedicated-worker"><span class="secno">1.3.2 </span>Communicating with a dedicated worker</a></li>
389: <li><a href="#shared-workers"><span class="secno">1.3.3 </span>Shared workers</a></ol></ol></li>
1.148 ihickson 390: <li><a href="#conformance-requirements"><span class="secno">2 </span>Conformance requirements</a>
1.82 ihickson 391: <ol>
1.148 ihickson 392: <li><a href="#dependencies"><span class="secno">2.1 </span>Dependencies</a></ol></li>
393: <li><a href="#terminology"><span class="secno">3 </span>Terminology</a></li>
394: <li><a href="#infrastructure"><span class="secno">4 </span>Infrastructure</a>
395: <ol>
1.301 ihickson 396: <li><a href="#dependencies-0"><span class="secno">4.1 </span>Dependencies</a></li>
397: <li><a href="#the-global-scope"><span class="secno">4.2 </span>The global scope</a>
1.81 ihickson 398: <ol>
1.316 ihickson 399: <li><a href="#the-workerglobalscope-common-interface"><span class="secno">4.2.1 </span>The <code>WorkerGlobalScope</code> common interface</a></li>
1.301 ihickson 400: <li><a href="#dedicated-workers-and-the-dedicatedworkerglobalscope-interface"><span class="secno">4.2.2 </span>Dedicated workers and the <code>DedicatedWorkerGlobalScope</code> interface</a></li>
401: <li><a href="#shared-workers-and-the-sharedworkerglobalscope-interface"><span class="secno">4.2.3 </span>Shared workers and the <code>SharedWorkerGlobalScope</code> interface</a></ol></li>
1.339 ihickson 402: <li><a href="#the-event-loop"><span class="secno">4.3 </span>The event loop</a></li>
403: <li><a href="#the-worker-s-lifetime"><span class="secno">4.4 </span>The worker's lifetime</a></li>
404: <li><a href="#processing-model"><span class="secno">4.5 </span>Processing model</a></li>
405: <li><a href="#runtime-script-errors"><span class="secno">4.6 </span>Runtime script errors</a></li>
406: <li><a href="#creating-workers"><span class="secno">4.7 </span>Creating workers</a>
1.81 ihickson 407: <ol>
1.339 ihickson 408: <li><a href="#the-abstractworker-abstract-interface"><span class="secno">4.7.1 </span>The <code>AbstractWorker</code> abstract interface</a></li>
409: <li><a href="#dedicated-workers-and-the-worker-interface"><span class="secno">4.7.2 </span>Dedicated workers and the <code>Worker</code> interface</a></li>
410: <li><a href="#shared-workers-and-the-sharedworker-interface"><span class="secno">4.7.3 </span>Shared workers and the <code>SharedWorker</code> interface</a></ol></ol></li>
1.148 ihickson 411: <li><a href="#apis-available-to-workers"><span class="secno">5 </span>APIs available to workers</a>
1.81 ihickson 412: <ol>
1.148 ihickson 413: <li><a href="#importing-scripts-and-libraries"><span class="secno">5.1 </span>Importing scripts and libraries</a></li>
1.210 ihickson 414: <li><a href="#the-workernavigator-object"><span class="secno">5.2 </span>The <code>WorkerNavigator</code> object</a></li>
1.272 ihickson 415: <li><a href="#interface-objects-and-constructors"><span class="secno">5.3 </span>Interface objects and constructors</a></li>
416: <li><a href="#worker-locations"><span class="secno">5.4 </span>Worker locations</a></ol></li>
1.115 ihickson 417: <li><a class="no-num" href="#references">References</a></li>
418: <li><a class="no-num" href="#acknowledgements">Acknowledgements</a></ol>
1.327 ihickson 419:
420: <hr><h2 id="introduction"><span class="secno">1 </span>Introduction</h2>
421:
422: <h3 id="scope"><span class="secno">1.1 </span>Scope</h3>
423:
424: <p><i>This section is non-normative.</i></p>
425:
426: <p>This specification defines an API for running scripts in the
427: background independently of any user interface scripts.</p>
428:
429: <p>This allows for long-running scripts that are not interrupted by
1.81 ihickson 430: scripts that respond to clicks or other user interactions, and
431: allows long tasks to be executed without yielding to keep the page
1.327 ihickson 432: responsive.</p>
433:
434: <p>Workers (as these background scripts are called herein) are
1.81 ihickson 435: relatively heavy-weight, and are not intended to be used in large
436: numbers. For example, it would be inappropriate to launch one worker
437: for each pixel of a four megapixel image. The examples below show
1.327 ihickson 438: some appropriate uses of workers.</p>
439:
440: <p>Generally, workers are expected to be long-lived, have a high
441: start-up performance cost, and a high per-instance memory cost.</p>
442:
443:
444: <h3 id="examples"><span class="secno">1.2 </span>Examples</h3>
445:
446: <p><i>This section is non-normative.</i></p>
447:
448: <p>There are a variety of uses that workers can be put to. The
449: following subsections show various examples of this use.</p>
450:
451: <h4 id="a-background-number-crunching-worker"><span class="secno">1.2.1 </span>A background number-crunching worker</h4>
452:
453: <p><i>This section is non-normative.</i></p>
454:
455: <p>The simplest use of workers is for performing a computationally
456: expensive task without interrupting the user interface.</p>
457:
458: <p>In this example, the main document spawns a worker to
1.155 ihickson 459: (naïvely) compute prime numbers, and progressively displays the
1.327 ihickson 460: most recently found prime number.</p>
461:
462: <p>The main page is as follows:</p>
463:
464: <pre><!DOCTYPE HTML>
1.81 ihickson 465: <html>
466: <head>
467: <title>Worker example: One-core computation</title>
468: </head>
469: <body>
470: <p>The highest prime number discovered so far is: <output id="result"></output></p>
471: <script>
1.50 ihickson 472: var worker = new Worker('worker.js');
473: worker.onmessage = function (event) {
1.54 ihickson 474: document.getElementById('result').textContent = event.data;
1.29 ihickson 475: };
1.81 ihickson 476: </script>
477: </body>
1.327 ihickson 478: </html></pre>
479:
480: <p>The <code title="dom-Worker"><a href="#dom-worker">Worker()</a></code> constructor call
1.115 ihickson 481: creates a worker and returns a <code><a href="#worker">Worker</a></code> object
1.81 ihickson 482: representing that worker, which is used to communicate with the
1.327 ihickson 483: worker. That object's <code title="handler-Worker-onmessage"><a href="#handler-worker-onmessage">onmessage</a></code> event handler allows the code to receive messages from the worker.</p>
484:
485: <p>The worker itself is as follows:</p>
486:
487: <pre>var n = 1;
1.29 ihickson 488: search: while (true) {
489: n += 1;
490: for (var i = 2; i <= Math.sqrt(n); i += 1)
491: if (n % i == 0)
492: continue search;
493: // found a prime!
1.50 ihickson 494: postMessage(n);
1.327 ihickson 495: }</pre>
496:
497: <p>The bulk of this code is simply an unoptimized search for a prime
1.295 ihickson 498: number. The <code title="dom-DedicatedWorkerGlobalScope-postMessage"><a href="#dom-dedicatedworkerglobalscope-postmessage">postMessage()</a></code>
499: method is used to send a message back to the page when a prime is
1.327 ihickson 500: found.</p>
501:
502: <p><a href="http://www.whatwg.org/demos/workers/primes/page.html">View this example online</a>.</p>
503:
504:
505:
506:
507: <h4 id="worker-used-for-background-i-o"><span class="secno">1.2.2 </span>Worker used for background I/O</h4>
508:
509: <p><i>This section is non-normative.</i></p>
510:
511: <p>In this example, the main document uses two workers, one for
1.81 ihickson 512: fetching stock updates for at regular intervals, and one for
1.327 ihickson 513: fetching performing search queries that the user requests.</p>
514:
515: <p>The main page is as follows:</p>
516:
517: <pre><!DOCTYPE HTML>
1.81 ihickson 518: <html>
519: <head>
520: <title>Worker example: Stock ticker</title>
521: <script>
1.33 ihickson 522: // TICKER
523: var symbol = 'GOOG'; // default symbol to watch
1.50 ihickson 524: var ticker = new Worker('ticker.js');
1.33 ihickson 525:
526: // SEARCHER
1.50 ihickson 527: var searcher = new Worker('searcher.js');
1.33 ihickson 528: function search(query) {
1.50 ihickson 529: searcher.postMessage(query);
1.33 ihickson 530: }
531:
532: // SYMBOL SELECTION UI
533: function select(newSymbol) {
534: symbol = newSymbol;
1.50 ihickson 535: ticker.postMessage(symbol);
1.33 ihickson 536: }
1.81 ihickson 537: </script>
538: </head>
1.122 ihickson 539: <body onload="search('')">
1.81 ihickson 540: <p><output id="symbol"></output> <output id="value"></output></p>
541: <script>
1.50 ihickson 542: ticker.onmessage = function (event) {
1.54 ihickson 543: var data = event.data.split(' ');
1.33 ihickson 544: document.getElementById('symbol').textContent = data[0];
545: document.getElementById('value').textContent = data[1];
546: };
1.50 ihickson 547: ticker.postMessage(symbol);
1.81 ihickson 548: </script>
1.122 ihickson 549: <p><label>Search: <input type="text" autofocus oninput="search(this.value)"></label></p>
1.81 ihickson 550: <ul id="results"></ul>
551: <script>
1.50 ihickson 552: searcher.onmessage = function (event) {
1.54 ihickson 553: var data = event.data.split(' ');
1.33 ihickson 554: var results = document.getElementById('results');
555: while (results.hasChildNodes()) // clear previous results
556: results.removeChild(results.firstChild);
557: for (var i = 0; i < data.length; i += 1) {
558: // add a list item with a button for each result
559: var li = document.createElement('li');
560: var button = document.createElement('button');
561: button.value = data[i];
562: button.type = 'button';
563: button.onclick = function () { select(this.value); };
564: button.textContent = data[i];
565: li.appendChild(button);
566: results.appendChild(li);
567: }
568: };
1.81 ihickson 569: </script>
570: <p>(The data in this example is not real. Try searching for "Google" or "Apple".)</p>
571: </body>
1.327 ihickson 572: </html></pre>
573:
574: <p>The two workers use a common library for performing the actual
575: network calls. This library is as follows:</p>
576:
577: <pre>function get(url) {
1.50 ihickson 578: try {
579: var xhr = new XMLHttpRequest();
580: xhr.open('GET', url, false);
581: xhr.send();
582: return xhr.responseText;
583: } catch (e) {
584: return ''; // turn all errors into empty results
585: }
1.327 ihickson 586: }</pre>
587:
588: <p>The stock updater worker is as follows:</p>
589:
590: <pre>importScripts('io.js');
1.33 ihickson 591: var timer;
592: var symbol;
593: function update() {
1.50 ihickson 594: postMessage(symbol + ' ' + get('stock.cgi?' + symbol));
1.33 ihickson 595: timer = setTimeout(update, 10000);
596: }
1.50 ihickson 597: onmessage = function (event) {
1.33 ihickson 598: if (timer)
599: clearTimeout(timer);
1.54 ihickson 600: symbol = event.data;
1.33 ihickson 601: update();
1.327 ihickson 602: };</pre>
603:
604: <p>The search query worker is as follows:</p>
605:
606: <pre>importScripts('io.js');
1.50 ihickson 607: onmessage = function (event) {
1.54 ihickson 608: postMessage(get('search.cgi?' + event.data));
1.327 ihickson 609: };</pre>
610:
611: <p><a href="http://www.whatwg.org/demos/workers/stocks/page.html">View this example online</a>.</p>
612:
613:
614: <h4 id="shared-workers-introduction"><span class="secno">1.2.3 </span>Shared workers introduction</h4>
615:
616: <p><i>This section is non-normative.</i></p>
617:
618: <p>This section introduces shared workers using a Hello World
1.238 ihickson 619: example. Shared workers use slightly different APIs, since each
1.327 ihickson 620: worker can have multiple connections.</p>
621:
622: <p>This first example shows how you connect to a worker and how a
1.238 ihickson 623: worker can send a message back to the page when it connects to
1.327 ihickson 624: it. Received messages are displayed in a log.</p>
625:
626: <p>Here is the HTML page:</p>
627:
628: <pre><!DOCTYPE HTML>
1.239 ihickson 629: <title>Shared workers: demo 1</title>
630: <pre id="log">Log:</pre>
631: <script>
632: var worker = new SharedWorker('test.js');
633: var log = document.getElementById('log');
634: worker.port.onmessage = function(e) { // note: not worker.onmessage!
635: log.textContent += '\n' + e.data;
636: }
637: </script>
1.327 ihickson 638: </pre>
639:
640: <p>Here is the JavaScript worker:</p>
641:
642: <pre>onconnect = function(e) {
1.239 ihickson 643: var port = e.ports[0];
644: port.postMessage('Hello World!');
645: }
1.327 ihickson 646: </pre>
647:
648: <p><a href="http://www.whatwg.org/demos/workers/shared/001/test.html">View this example online</a>.</p>
649:
650: <hr><p>This second example extends the first one by changing two things:
1.238 ihickson 651: first, messages are received using <code title="">addEventListener()</code> instead of an <span title="event
652: handler IDL attributes">event handler IDL attribute</span>, and
653: second, a message is sent <em>to</em> the worker, causing the worker
654: to send another message in return. Received messages are again
1.327 ihickson 655: displayed in a log.</p>
656:
657: <p>Here is the HTML page:</p>
658:
659: <pre><!DOCTYPE HTML>
1.240 ihickson 660: <title>Shared workers: demo 2</title>
1.239 ihickson 661: <pre id="log">Log:</pre>
662: <script>
663: var worker = new SharedWorker('test.js');
664: var log = document.getElementById('log');
1.240 ihickson 665: worker.port.addEventListener('message', function(e) {
1.239 ihickson 666: log.textContent += '\n' + e.data;
1.240 ihickson 667: }, false);
668: worker.port.start(); // note: need this when using addEventListener
669: worker.port.postMessage('ping');
1.239 ihickson 670: </script>
1.327 ihickson 671: </pre>
672:
673: <p>Here is the JavaScript worker:</p>
674:
675: <pre>onconnect = function(e) {
1.239 ihickson 676: var port = e.ports[0];
677: port.postMessage('Hello World!');
1.240 ihickson 678: port.onmessage = function(e) {
679: port.postMessage('pong'); // not e.ports[0].postMessage!
680: // e.target.postMessage('pong'); would work also
681: }
1.239 ihickson 682: }
1.327 ihickson 683: </pre>
684:
685: <p><a href="http://www.whatwg.org/demos/workers/shared/002/test.html">View this example online</a>.</p>
686:
687: <hr><p>Finally, the example is extended to show how two pages can
1.238 ihickson 688: connect to the same worker; in this case, the second page is merely
689: in an <code>iframe</code> on the first page, but the same principle
690: would apply to an entirely separate page in a separate
1.327 ihickson 691: <span>top-level browsing context</span>.</p>
692:
693: <p>Here is the outer HTML page:</p>
694:
695: <pre><!DOCTYPE HTML>
1.239 ihickson 696: <title>Shared workers: demo 3</title>
697: <pre id="log">Log:</pre>
698: <script>
699: var worker = new SharedWorker('test.js');
700: var log = document.getElementById('log');
701: worker.port.addEventListener('message', function(e) {
702: log.textContent += '\n' + e.data;
703: }, false);
704: worker.port.start();
705: worker.port.postMessage('ping');
706: </script>
707: <iframe src="inner.html"></iframe>
1.327 ihickson 708: </pre>
709:
710: <p>Here is the inner HTML page:</p>
711:
712: <pre><!DOCTYPE HTML>
1.239 ihickson 713: <title>Shared workers: demo 3 inner frame</title>
714: <pre id=log>Inner log:</pre>
715: <script>
716: var worker = new SharedWorker('test.js');
717: var log = document.getElementById('log');
718: worker.port.onmessage = function(e) {
719: log.textContent += '\n' + e.data;
720: }
721: </script>
1.327 ihickson 722: </pre>
723:
724: <p>Here is the JavaScript worker:</p>
725:
726: <pre>var count = 0;
1.239 ihickson 727: onconnect = function(e) {
728: count += 1;
729: var port = e.ports[0];
730: port.postMessage('Hello World! You are connection #' + count);
731: port.onmessage = function(e) {
732: port.postMessage('pong');
733: }
734: }
1.327 ihickson 735: </pre>
736:
737: <p><a href="http://www.whatwg.org/demos/workers/shared/003/test.html">View this example online</a>.</p>
738:
739:
740: <h4 id="shared-state-using-a-shared-worker"><span class="secno">1.2.4 </span>Shared state using a shared worker</h4>
741:
742: <p><i>This section is non-normative.</i></p>
743:
744: <p>In this example, multiple windows (viewers) can be opened that
1.81 ihickson 745: are all viewing the same map. All the windows share the same map
746: information, with a single worker coordinating all the viewers. Each
747: viewer can move around independently, but if they set any data on
1.327 ihickson 748: the map, all the viewers are updated.</p>
749:
750: <p>The main page isn't interesting, it merely provides a way to open
751: the viewers:</p>
752:
753: <pre><!DOCTYPE HTML>
1.81 ihickson 754: <html>
755: <head>
756: <title>Workers example: Multiviewer</title>
757: <script>
1.36 ihickson 758: function openViewer() {
759: window.open('viewer.html');
760: }
1.81 ihickson 761: </script>
762: </head>
763: <body>
764: <p><button type=button onclick="openViewer()">Open a new
765: viewer</button></p>
766: <p>Each viewer opens in a new window. You can have as many viewers
767: as you like, they all view the same data.</p>
768: </body>
1.327 ihickson 769: </html></pre>
770:
771: <p>The viewer is more involved:</p>
772:
773: <pre><!DOCTYPE HTML>
1.81 ihickson 774: <html>
775: <head>
776: <title>Workers example: Multiviewer viewer</title>
777: <script>
1.50 ihickson 778: var worker = new SharedWorker('worker.js', 'core');
1.36 ihickson 779:
780: // CONFIGURATION
781: function configure(event) {
1.54 ihickson 782: if (event.data.substr(0, 4) != 'cfg ') return;
783: var name = event.data.substr(4).split(' ', 1);
1.36 ihickson 784: // update display to mention our name is name
785: document.getElementsByTagName('h1')[0].textContent += ' ' + name;
786: // no longer need this listener
1.43 ihickson 787: worker.port.removeEventListener('message', configure, false);
1.36 ihickson 788: }
1.53 ihickson 789: worker.port.addEventListener('message', configure, false);
1.36 ihickson 790:
791: // MAP
792: function paintMap(event) {
1.54 ihickson 793: if (event.data.substr(0, 4) != 'map ') return;
794: var data = event.data.substr(4).split(',');
1.36 ihickson 795: // display tiles data[0] .. data[8]
796: var canvas = document.getElementById('map');
797: var context = canvas.getContext('2d');
798: for (var y = 0; y < 3; y += 1) {
799: for (var x = 0; x < 3; x += 1) {
800: var tile = data[y * 3 + x];
801: if (tile == '0')
802: context.fillStyle = 'green';
803: else
804: context.fillStyle = 'maroon';
805: fillRect(x * 50, y * 50, 50, 50);
806: }
807: }
808: }
1.53 ihickson 809: worker.port.addEventListener('message', paintMap, false);
1.36 ihickson 810:
811: // PUBLIC CHAT
812: function updatePublicChat(event) {
1.54 ihickson 813: if (event.data.substr(0, 4) != 'txt ') return;
814: var name = event.data.substr(4).split(' ', 1);
815: var message = event.data.substr(4 + length(name) + 1);
1.81 ihickson 816: // display "<name> message" in public chat
1.36 ihickson 817: var dialog = document.getElementById('public');
818: var dt = document.createElement('dt');
819: dt.textContent = name;
820: dialog.appendChild(dt);
821: var dd = document.createElement('dd');
822: dd.textContent = message;
823: dialog.appendChild(dd);
824: }
1.53 ihickson 825: worker.port.addEventListener('message', updatePublicChat, false);
1.36 ihickson 826:
827: // PRIVATE CHAT
828: function startPrivateChat(event) {
1.54 ihickson 829: if (event.data.substr(0, 4) != 'msg ') return;
830: var name = event.data.substr(4).split(' ', 1);
1.84 ihickson 831: var port = event.ports[0];
1.36 ihickson 832: // display a private chat UI
833: var ul = document.getElementById('private');
834: var li = document.createElement('li');
835: var h3 = document.createElement('h3');
836: h3.textContent = 'Private chat with ' + name;
837: li.appendChild(h3);
838: var dialog = document.createElement('dialog');
839: var addMessage = function(name, message) {
840: var dt = document.createElement('dt');
841: dt.textContent = name;
842: dialog.appendChild(dt);
843: var dd = document.createElement('dd');
844: dd.textContent = message;
845: dialog.appendChild(dd);
846: };
847: port.onmessage = function (event) {
1.54 ihickson 848: addMessage(name, event.data);
1.36 ihickson 849: };
850: li.appendChild(dialog);
851: var form = document.createElement('form');
852: var p = document.createElement('p');
853: var input = document.createElement('input');
854: input.size = 50;
855: p.appendChild(input);
856: p.appendChild(document.createTextNode(' '));
857: var button = document.createElement('button');
858: button.textContent = 'Post';
859: p.appendChild(button);
860: form.onsubmit = function () {
861: port.postMessage(input.value);
862: addMessage('me', input.value);
863: input.value = '';
864: return false;
865: };
866: form.appendChild(p);
867: li.appendChild(form);
868: }
1.53 ihickson 869: worker.port.addEventListener('message', startPrivateChat, false);
1.188 ihickson 870:
871: worker.port.start();
1.81 ihickson 872: </script>
873: </head>
874: <body>
875: <h1>Viewer</h1>
876: <h2>Map</h2>
877: <p><canvas id="map" height=150 width=150></canvas></p>
878: <p>
879: <button type=button onclick="worker.port.postMessage('mov left')">Left</button>
880: <button type=button onclick="worker.port.postMessage('mov up')">Up</button>
881: <button type=button onclick="worker.port.postMessage('mov down')">Down</button>
882: <button type=button onclick="worker.port.postMessage('mov right')">Right</button>
883: <button type=button onclick="worker.port.postMessage('set 0')">Set 0</button>
884: <button type=button onclick="worker.port.postMessage('set 1')">Set 1</button>
885: </p>
886: <h2>Public Chat</h2>
887: <dialog id="public"></dialog>
888: <form onsubmit="worker.port.postMessage('txt ' + message.value); message.value = ''; return false;">
889: <p>
890: <input type="text" name="message" size="50">
891: <button>Post</button>
892: </p>
893: </form>
894: <h2>Private Chat</h2>
895: <ul id="private"></ul>
896: </body>
897: </html>
1.327 ihickson 898: </pre>
899:
900: <p>There are several key things worth noting about the way the
901: viewer is written.</p>
902:
903: <p><strong>Multiple listeners</strong>. Instead of a single message
1.81 ihickson 904: processing function, the code here attaches multiple event
905: listeners, each one performing a quick check to see if it is
906: relevant for the message. In this example it doesn't make much
907: difference, but if multiple authors wanted to collaborate using a
908: single port to communicate with a worker, it would allow for
909: independent code instead of changes having to all be made to a
1.327 ihickson 910: single event handling function.</p>
911:
912: <p>Registering event listeners in this way also allows you to
1.81 ihickson 913: unregister specific listeners when you are done with them, as is
914: done with the <code title="">configure()</code> method in this
1.327 ihickson 915: example.</p>
916:
917: <p>Finally, the worker:</p>
918:
919: <pre>
1.155 ihickson 920: var nextName = 0;
1.36 ihickson 921: function getNextName() {
922: // this could use more friendly names
923: // but for now just return a number
924: return nextName++;
925: }
926:
927: var map = [
928: [0, 0, 0, 0, 0, 0, 0],
929: [1, 1, 0, 1, 0, 1, 1],
930: [0, 1, 0, 1, 0, 0, 0],
931: [0, 1, 0, 1, 0, 1, 1],
932: [0, 0, 0, 1, 0, 0, 0],
933: [1, 0, 0, 1, 1, 1, 1],
934: [1, 1, 0, 1, 1, 0, 1],
935: ];
936:
937: function wrapX(x) {
938: if (x < 0) return wrapX(x + map[0].length);
1.81 ihickson 939: if (x >= map[0].length) return wrapX(x - map[0].length);
1.36 ihickson 940: return x;
941: }
942:
943: function wrapY(y) {
944: if (y < 0) return wrapY(y + map.length);
1.81 ihickson 945: if (y >= map[0].length) return wrapY(y - map.length);
1.36 ihickson 946: return y;
947: }
948:
1.50 ihickson 949: function sendMapData(callback) {
1.36 ihickson 950: var data = '';
951: for (var y = viewer.y-1; y <= viewer.y+1; y += 1) {
952: for (var x = viewer.x-1; x <= viewer.x+1; x += 1) {
953: if (data != '')
954: data += ',';
955: data += map[y][x];
956: }
957: }
1.50 ihickson 958: callback('map ' + data);
1.36 ihickson 959: }
960:
961: var viewers = {};
962: onconnect = function (event) {
1.84 ihickson 963: event.ports[0]._name = getNextName();
964: event.ports[0]._data = { port: event.port, x: 0, y: 0, };
965: viewers[event.ports[0]._name] = event.port._data;
966: event.ports[0].postMessage('cfg ' + name);
967: event.ports[0].onmessage = getMessage;
968: sendMapData(event.ports[0].postMessage);
1.36 ihickson 969: };
970:
971: function getMessage(event) {
1.54 ihickson 972: switch (event.data.substr(0, 4)) {
1.36 ihickson 973: case 'mov ':
1.54 ihickson 974: var direction = event.data.substr(4);
1.36 ihickson 975: var dx = 0;
976: var dy = 0;
977: switch (direction) {
978: case 'up': dy = -1; break;
979: case 'down': dy = 1; break;
980: case 'left': dx = -1; break;
981: case 'right': dx = 1; break;
982: }
983: event.target._data.x = wrapX(event.target._data.x + dx);
984: event.target._data.y = wrapY(event.target._data.y + dy);
1.50 ihickson 985: sendMapData(event.target.postMessage);
1.36 ihickson 986: break;
987: case 'set ':
1.54 ihickson 988: var value = event.data.substr(4);
1.36 ihickson 989: map[event.target._data.y][event.target._data.x] = value;
990: for (var viewer in viewers)
1.50 ihickson 991: sendMapData(viewers[viewer].port.postMessage);
1.36 ihickson 992: break;
993: case 'txt ':
994: var name = event.target._name;
1.54 ihickson 995: var message = event.data.substr(4);
1.36 ihickson 996: for (var viewer in viewers)
997: viewers[viewer].port.postMessage('txt ' + name + ' ' + message);
998: break;
999: case 'msg ':
1000: var party1 = event._data;
1.54 ihickson 1001: var party2 = viewers[event.data.substr(4).split(' ', 1)];
1.36 ihickson 1002: if (party2) {
1003: var channel = new MessageChannel();
1.84 ihickson 1004: party1.port.postMessage('msg ' + party2.name, [channel.port1]);
1005: party2.port.postMessage('msg ' + party1.name, [channel.port2]);
1.36 ihickson 1006: }
1007: break;
1008: }
1.327 ihickson 1009: }</pre>
1010:
1011: <p><strong>Connecting to multiple pages</strong>. The script uses
1.115 ihickson 1012: the <code title="handler-SharedWorkerGlobalScope-onconnect"><a href="#handler-sharedworkerglobalscope-onconnect">onconnect</a></code>
1.327 ihickson 1013: event listener to listen for multiple connections.</p>
1014:
1015: <p><strong>Direct channels</strong>. When the worker receives a
1.81 ihickson 1016: "msg" message from one viewer naming another viewer, it sets up a
1017: direct connection between the two, so that the two viewers can
1018: communicate directly without the worker having to proxy all the
1.327 ihickson 1019: messages.</p>
1020:
1021: <p><a href="http://www.whatwg.org/demos/workers/multiviewer/page.html">View this example online</a>.</p>
1022:
1023:
1024: <h4 id="delegation"><span class="secno">1.2.5 </span>Delegation</h4>
1025:
1026: <p><i>This section is non-normative.</i></p>
1027:
1028: <p>With multicore CPUs becoming prevalent, one way to obtain better
1.81 ihickson 1029: performance is to split computationally expensive tasks amongst
1030: multiple workers. In this example, a computationally expensive task
1031: that is to be performed for every number from 1 to 10,000,000 is
1.327 ihickson 1032: farmed out to ten subworkers.</p>
1033:
1034: <p>The main page is as follows, it just reports the result:</p>
1035:
1036: <pre><!DOCTYPE HTML>
1.81 ihickson 1037: <html>
1038: <head>
1.203 ihickson 1039: <title>Worker example: Multicore computation</title>
1.81 ihickson 1040: </head>
1041: <body>
1.203 ihickson 1042: <p>Result: <output id="result"></output></p>
1.81 ihickson 1043: <script>
1.50 ihickson 1044: var worker = new Worker('worker.js');
1045: worker.onmessage = function (event) {
1.54 ihickson 1046: document.getElementById('result').textContent = event.data;
1.40 ihickson 1047: };
1.81 ihickson 1048: </script>
1049: </body>
1.327 ihickson 1050: </html></pre>
1051:
1052: <p>The worker itself is as follows:</p>
1053:
1054: <pre>// settings
1.40 ihickson 1055: var num_workers = 10;
1056: var items_per_worker = 1000000;
1057:
1058: // start the workers
1059: var result = 0;
1060: var pending_workers = num_workers;
1061: for (var i = 0; i < num_workers; i += 1) {
1.50 ihickson 1062: var worker = new Worker('core.js');
1063: worker.postMessage(i * items_per_worker);
1064: worker.postMessage((i+1) * items_per_worker);
1065: worker.onmessage = storeResult;
1.40 ihickson 1066: }
1067:
1068: // handle the results
1069: function storeResult(event) {
1.54 ihickson 1070: result += 1*event.data;
1.40 ihickson 1071: pending_workers -= 1;
1072: if (pending_workers <= 0)
1.50 ihickson 1073: postMessage(result); // finished!
1.327 ihickson 1074: }</pre>
1075:
1076: <p>It consists of a loop to start the subworkers, and then a handler
1077: that waits for all the subworkers to respond.</p>
1078:
1079: <p>The subworkers are implemented as follows:</p>
1080:
1081: <pre>var start;
1.41 ihickson 1082: onmessage = getStart;
1.40 ihickson 1083: function getStart(event) {
1.54 ihickson 1084: start = 1*event.data;
1.40 ihickson 1085: onmessage = getEnd;
1086: }
1087:
1088: var end;
1089: function getEnd(event) {
1.54 ihickson 1090: end = 1*event.data;
1.40 ihickson 1091: onmessage = null;
1.66 ihickson 1092: work();
1.40 ihickson 1093: }
1094:
1.66 ihickson 1095: function work() {
1.40 ihickson 1096: var result = 0;
1097: for (var i = start; i < end; i += 1) {
1098: // perform some complex calculation here
1099: result += 1;
1100: }
1.50 ihickson 1101: postMessage(result);
1102: close();
1.327 ihickson 1103: }</pre>
1104:
1105: <p>They receive two numbers in two events, perform the computation
1.81 ihickson 1106: for the range of numbers thus specified, and then report the result
1.327 ihickson 1107: back to the parent.</p>
1108:
1109: <p><a href="http://www.whatwg.org/demos/workers/multicore/page.html">View this example online</a>.</p>
1110:
1111:
1112:
1113:
1114: <h3 id="tutorials"><span class="secno">1.3 </span>Tutorials</h3>
1115:
1116: <h4 id="creating-a-dedicated-worker"><span class="secno">1.3.1 </span>Creating a dedicated worker</h4>
1117:
1118: <p><i>This section is non-normative.</i></p>
1119:
1120: <p>Creating a worker requires a URL to a JavaScript file. The <code title="dom-Worker"><a href="#dom-worker">Worker()</a></code> constructor is invoked with the
1.303 ihickson 1121: URL to that file as its only argument; a worker is then created and
1.327 ihickson 1122: returned:</p>
1123:
1124: <pre>var worker = new Worker('helper.js');</pre>
1125:
1126:
1127: <h4 id="communicating-with-a-dedicated-worker"><span class="secno">1.3.2 </span>Communicating with a dedicated worker</h4>
1128:
1129: <p><i>This section is non-normative.</i></p>
1130:
1131: <p>Dedicated workers use <code><a href="#messageport">MessagePort</a></code> objects behind the
1.303 ihickson 1132: scenes, and thus support all the same features, such as sending
1133: structured data, transferring binary data, and transferring other
1.327 ihickson 1134: ports.</p>
1135:
1136: <p>To receive messages from a dedicated worker, use the <code title="handler-worker-onmessage"><a href="#handler-worker-onmessage">onmessage</a></code> <span title="event
1.303 ihickson 1137: handler IDL attributes">event handler IDL attribute</span> on the
1.327 ihickson 1138: <code><a href="#worker">Worker</a></code> object:</p>
1139:
1140: <pre>worker.onmessage = function (event) { ... };</pre>
1141:
1142: <p>You can also use the <code title="dom-EventTarget-addEventListener">addEventListener()</code> method.</p>
1143:
1144: <p class="note">The implicit <code><a href="#messageport">MessagePort</a></code> used by
1.303 ihickson 1145: dedicated workers has its <span>port message queue</span> implicitly
1.336 ihickson 1146: enabled when it is created, so there is no equivalent to the
1.303 ihickson 1147: <code><a href="#messageport">MessagePort</a></code> interface's <code title="dom-MessagePort-start">start()</code> method on the
1.327 ihickson 1148: <code><a href="#worker">Worker</a></code> interface.</p>
1149:
1150: <p>To <em>send</em> data to a worker, use the <code title="dom-Worker-postMessage"><a href="#dom-worker-postmessage">postMessage()</a></code> method.
1.303 ihickson 1151: Structured data can be sent over this communication channel. To send
1152: <code>ArrayBuffer</code> objects efficiently (by transferring them
1153: rather than cloning them), list them in an array in the second
1.327 ihickson 1154: argument.</p>
1155:
1156: <pre>worker.postMessage({
1.303 ihickson 1157: operation: 'find-edges',
1158: input: buffer, // an ArrayBuffer object
1159: threshold: 0.6,
1.327 ihickson 1160: }, [buffer]);</pre>
1161:
1162: <p>To receive a message inside the worker, the <code title="handler-DedicatedWorkerGlobalScope-onmessage"><a href="#handler-dedicatedworkerglobalscope-onmessage">onmessage</a></code>
1.303 ihickson 1163: <span title="event handler IDL attributes">event handler IDL
1.327 ihickson 1164: attribute</span> is used.</p>
1165:
1166: <pre>onmessage = function (event) { ... };</pre>
1167:
1168: <p>You can again also use the <code title="dom-EventTarget-addEventListener">addEventListener()</code>
1169: method.</p>
1170:
1171: <p>In either case, the data is provided in the event object's <code title="dom-MessageEvent-data">data</code> attribute.</p>
1172:
1173: <p>To send messages back, you again use <code title="dom-DedicatedWorkerGlobalScope-postMessage"><a href="#dom-dedicatedworkerglobalscope-postmessage">postMessage()</a></code>.
1174: It supports the structured data in the same manner.</p>
1175:
1176: <pre>postMessage(event.data.input, [event.data.input]); // transfer the buffer back</pre>
1177:
1178:
1179: <h4 id="shared-workers"><span class="secno">1.3.3 </span>Shared workers</h4>
1180:
1181: <p><i>This section is non-normative.</i></p>
1182:
1183: <p>Shared workers are identified in one of two ways: either by the
1.303 ihickson 1184: URL of the script used to create it, or by explicit name. When
1185: created by name, the URL used by the first page to create the worker
1186: with that name is the URL of the script that will be used for that
1187: worker. This allows multiple applications on a domain to all use a
1188: single shared worker to provide a common service, without the
1189: applications having to keep track of a common URL for the script
1.327 ihickson 1190: used to provide the service.</p>
1191:
1192: <p class="note">In either case, shared workers are scoped by
1.303 ihickson 1193: <span>origin</span>. Two different sites using the same names will
1.327 ihickson 1194: not collide.</p>
1195:
1196: <p>Creating shared workers is done using the <code title="dom-SharedWorker"><a href="#dom-sharedworker">SharedWorker()</a></code> constructor. This
1.303 ihickson 1197: constructor takes the URL to the script to use for its first
1198: argument, and the name of the worker, if any, as the second
1.327 ihickson 1199: argument.</p>
1200:
1201: <pre>var worker = new SharedWorker('service.js');</pre>
1202:
1203: <p>Communicating with shared workers is done with explicit
1.303 ihickson 1204: <code><a href="#messageport">MessagePort</a></code> objects. The object returned by the <code title="dom-SharedWorker"><a href="#dom-sharedworker">SharedWorker()</a></code> constructor holds a
1.327 ihickson 1205: reference to the port on its <code title="dom-SharedWorker-port"><a href="#dom-sharedworker-port">port</a></code> attribute.</p>
1206:
1207: <pre>worker.port.onmessage = function (event) { ... };
1.303 ihickson 1208: worker.port.postMessage('some message');
1.327 ihickson 1209: worker.port.postMessage({ foo: 'structured', bar: ['data', 'also', 'possible']});</pre>
1210:
1211: <p>Inside the shared worker, new clients of the worker are announced
1.303 ihickson 1212: using the <code title="event-connect">connect</code> event. The port
1.330 ihickson 1213: for the new client is given by the event object's <code title="dom-messageevent-source">source</code> attribute.</p>
1.327 ihickson 1214:
1215: <pre>onconnect = function (event) {
1.330 ihickson 1216: var newPort = event.source;
1.303 ihickson 1217: // set up a listener
1218: newPort.onmessage = function (event) { ... };
1219: // send a message back to the port
1220: newPort.postMessage('ready!'); // can also send structured data, of course
1.327 ihickson 1221: };</pre>
1222:
1223:
1224:
1225:
1226:
1227:
1228: <h2 id="conformance-requirements"><span class="secno">2 </span>Conformance requirements</h2>
1229:
1230: <p>All diagrams, examples, and notes in this specification are
1.81 ihickson 1231: non-normative, as are all sections explicitly marked non-normative.
1.327 ihickson 1232: Everything else in this specification is normative.</p>
1233:
1234: <p>The key words "MUST", "MUST NOT", "REQUIRED", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and
1.81 ihickson 1235: "OPTIONAL" in the normative parts of this document are to be
1236: interpreted as described in RFC2119. For readability, these words do
1.327 ihickson 1237: not appear in all uppercase letters in this specification. <a href="#refsRFC2119">[RFC2119]</a></p>
1238:
1239: <p>Requirements phrased in the imperative as part of algorithms
1.81 ihickson 1240: (such as "strip any leading space characters" or "return false and
1241: abort these steps") are to be interpreted with the meaning of the
1242: key word ("must", "should", "may", etc) used in introducing the
1.327 ihickson 1243: algorithm.</p>
1244:
1245: <p>Some conformance requirements are phrased as requirements on
1.81 ihickson 1246: attributes, methods or objects. Such requirements are to be
1.327 ihickson 1247: interpreted as requirements on user agents.</p>
1248:
1249: <p>Conformance requirements phrased as algorithms or specific steps
1.81 ihickson 1250: may be implemented in any manner, so long as the end result is
1251: equivalent. (In particular, the algorithms defined in this
1252: specification are intended to be easy to follow, and not intended to
1.327 ihickson 1253: be performant.)</p>
1254:
1255: <p>The only conformance class defined by this specification is user
1256: agents.</p>
1257:
1258: <p>User agents may impose implementation-specific limits on
1.81 ihickson 1259: otherwise unconstrained inputs, e.g. to prevent denial of service
1260: attacks, to guard against running out of memory, or to work around
1.327 ihickson 1261: platform-specific limitations.</p>
1262:
1263: <p>When support for a feature is disabled (e.g. as an emergency
1.229 ihickson 1264: measure to mitigate a security problem, or to aid in development, or
1265: for performance reasons), user agents must act as if they had no
1266: support for the feature whatsoever, and as if the feature was not
1267: mentioned in this specification. For example, if a particular
1268: feature is accessed via an attribute in a Web IDL interface, the
1269: attribute itself would be omitted from the objects that implement
1270: that interface — leaving the attribute on the object but
1.327 ihickson 1271: making it return null or throw an exception is insufficient.</p>
1272:
1273:
1274: <h3 id="dependencies"><span class="secno">2.1 </span>Dependencies</h3>
1275:
1276: <p>This specification relies on several other underlying
1277: specifications.</p>
1278:
1279: <dl><dt>HTML</dt>
1.49 ihickson 1280:
1.81 ihickson 1281: <dd>
1.49 ihickson 1282:
1.226 ihickson 1283: <p>Many fundamental concepts from HTML are used by this
1284: specification. <a href="#refsHTML">[HTML]</a></p>
1.49 ihickson 1285:
1.81 ihickson 1286: </dd>
1.1 ihickson 1287:
1.81 ihickson 1288: <dt>WebIDL</dt>
1.1 ihickson 1289:
1290: <dd>
1291:
1.81 ihickson 1292: <p>The IDL blocks in this specification use the semantics of the
1.153 ihickson 1293: WebIDL specification. <a href="#refsWEBIDL">[WEBIDL]</a></p>
1.1 ihickson 1294:
1.81 ihickson 1295: </dd>
1.1 ihickson 1296:
1.327 ihickson 1297: </dl><h2 id="terminology"><span class="secno">3 </span>Terminology</h2>
1298:
1299: <p>The construction "a <code title="">Foo</code> object", where
1.81 ihickson 1300: <code title="">Foo</code> is actually an interface, is sometimes
1301: used instead of the more accurate "an object implementing the
1.327 ihickson 1302: interface <code title="">Foo</code>".</p>
1303:
1304: <p>The term DOM is used to refer to the API set made available to
1.81 ihickson 1305: scripts in Web applications, and does not necessarily imply the
1306: existence of an actual <code>Document</code> object or of any other
1307: <code>Node</code> objects as defined in the DOM Core
1.327 ihickson 1308: specifications. <a href="#refsDOMCORE">[DOMCORE]</a></p>
1309:
1310: <p>An IDL attribute is said to be <em>getting</em> when its value is
1.81 ihickson 1311: being retrieved (e.g. by author script), and is said to be
1.327 ihickson 1312: <em>setting</em> when a new value is assigned to it.</p>
1313:
1314:
1315: <p>The term "JavaScript" is used to refer to ECMA262, rather than
1.103 ihickson 1316: the official term ECMAScript, since the term JavaScript is more
1.327 ihickson 1317: widely known. <a href="#refsECMA262">[ECMA262]</a></p>
1318:
1319:
1320:
1321: <h2 id="infrastructure"><span class="secno">4 </span>Infrastructure</h2>
1322:
1323: <p>There are two kinds of workers; dedicated workers, and shared
1.81 ihickson 1324: workers. Dedicated workers, once created, and are linked to their
1325: creator; but message ports can be used to communicate from a
1326: dedicated worker to multiple other browsing contexts or
1327: workers. Shared workers, on the other hand, are named, and once
1328: created any script running in the same <span>origin</span> can
1.327 ihickson 1329: obtain a reference to that worker and communicate with it.</p>
1330:
1331:
1332: <h3 id="dependencies-0"><span class="secno">4.1 </span>Dependencies</h3>
1333: <p>The <dfn id="messageport"><code>MessagePort</code></dfn> interface is defined in
1334: the HTML specification. <a href="#refsHTML">[HTML]</a></p>
1335:
1336:
1337:
1338: <h3 id="the-global-scope"><span class="secno">4.2 </span>The global scope</h3>
1339:
1340: <p>The global scope is the "inside" of a worker.</p>
1341:
1342: <h4 id="the-workerglobalscope-common-interface"><span class="secno">4.2.1 </span>The <code><a href="#workerglobalscope">WorkerGlobalScope</a></code> common interface</h4>
1343:
1344: <pre class="idl">interface <dfn id="workerglobalscope">WorkerGlobalScope</dfn> : <span>EventTarget</span> {
1.115 ihickson 1345: readonly attribute <a href="#workerglobalscope">WorkerGlobalScope</a> <a href="#dom-workerglobalscope-self" title="dom-WorkerGlobalScope-self">self</a>;
1346: readonly attribute <a href="#workerlocation">WorkerLocation</a> <a href="#dom-workerglobalscope-location" title="dom-WorkerGlobalScope-location">location</a>;
1347:
1348: void <a href="#dom-workerglobalscope-close" title="dom-WorkerGlobalScope-close">close</a>();
1.332 ihickson 1349: attribute <span>EventHandler</span> <a href="#handler-workerglobalscope-onerror" title="handler-WorkerGlobalScope-onerror">onerror</a>;
1350: attribute <span>EventHandler</span> <a href="#handler-workerglobalscope-onoffline" title="handler-WorkerGlobalScope-onoffline">onoffline</a>;
1351: attribute <span>EventHandler</span> <a href="#handler-workerglobalscope-ononline" title="handler-WorkerGlobalScope-ononline">ononline</a>;
1.150 ihickson 1352: };
1.327 ihickson 1353: <a href="#workerglobalscope">WorkerGlobalScope</a> implements <a href="#workerutils">WorkerUtils</a>;</pre>
1354:
1355: <p>The <dfn id="dom-workerglobalscope-self" title="dom-WorkerGlobalScope-self"><code>self</code></dfn> attribute
1356: must return the <code><a href="#workerglobalscope">WorkerGlobalScope</a></code> object itself.</p>
1357:
1358: <p>The <dfn id="dom-workerglobalscope-location" title="dom-WorkerGlobalScope-location"><code>location</code></dfn>
1.115 ihickson 1359: attribute must return the <code><a href="#workerlocation">WorkerLocation</a></code> object created
1360: for the <code><a href="#workerglobalscope">WorkerGlobalScope</a></code> object when the worker was
1.81 ihickson 1361: created. It represents the <span>absolute URL</span> of the script
1.327 ihickson 1362: that was used to initialize the worker, after any redirects.</p>
1363:
1364: <hr><p>When a script invokes the <dfn id="dom-workerglobalscope-close" title="dom-WorkerGlobalScope-close"><code>close()</code></dfn>
1.123 ihickson 1365: method on a <code><a href="#workerglobalscope">WorkerGlobalScope</a></code> object, the user agent
1.327 ihickson 1366: must run the following steps (atomically):</p>
1367:
1368: <ol><li><p>Discard any <span title="concept-task">tasks</span> that
1.123 ihickson 1369: have been added to the <span>event loop</span>'s <span title="task
1370: queue">task queues</span>.</p>
1371:
1.81 ihickson 1372:
1.318 ihickson 1373:
1.115 ihickson 1374: <li><p>Set the worker's <code><a href="#workerglobalscope">WorkerGlobalScope</a></code> object's
1375: <a href="#dom-workerglobalscope-closing" title="dom-WorkerGlobalScope-closing">closing</a> flag to
1.123 ihickson 1376: true. (This prevents any further tasks from being queued.)</li>
1.81 ihickson 1377:
1.339 ihickson 1378: </ol><hr><p>The following are the <span>event handlers</span> (and their
1.177 ihickson 1379: corresponding <span title="event handler event type">event handler
1380: event types</span>) that must be supported, as IDL attributes, by
1381: objects implementing the <code><a href="#workerglobalscope">WorkerGlobalScope</a></code>
1.327 ihickson 1382: interface:</p>
1383:
1384: <table><thead><tr><th><span title="event handlers">Event handler</span> <th><span>Event handler event type</span>
1.281 ihickson 1385: <tbody><tr><td><dfn id="handler-workerglobalscope-onerror" title="handler-WorkerGlobalScope-onerror"><code>onerror</code></dfn> <td> <code title="event-error">error</code>
1.289 ihickson 1386: <tr><td><dfn id="handler-workerglobalscope-onoffline" title="handler-WorkerGlobalScope-onoffline"><code>onoffline</code></dfn> <td> <code title="event-offline">offline</code>
1387: <tr><td><dfn id="handler-workerglobalscope-ononline" title="handler-WorkerGlobalScope-ononline"><code>ononline</code></dfn> <td> <code title="event-online">online</code>
1.339 ihickson 1388: </table><hr><p>Each <code><a href="#workerglobalscope">WorkerGlobalScope</a></code> object has a <dfn id="worker-origin">worker
1389: origin</dfn> that is set when the object is created.</p>
1390:
1391: <p class="note">For <span title="data protocol"><code title="">data:</code> URLs</span>, this is the <span>origin</span>
1392: of the <span>entry script</span> that called the constructor. For
1393: other <span title="URL">URLs</span>, this is the <span>origin</span>
1394: of the value of the <span>absolute URL</span> given in the worker's
1395: <code title="dom-WorkerGlobalScope-location"><a href="#dom-workerglobalscope-location"></a></code> attribute.</p>
1396:
1397:
1398:
1399: <h4 id="dedicated-workers-and-the-dedicatedworkerglobalscope-interface"><span class="secno">4.2.2 </span>Dedicated workers and the <code><a href="#dedicatedworkerglobalscope">DedicatedWorkerGlobalScope</a></code> interface</h4>
1.327 ihickson 1400:
1401: <pre class="idl">interface <dfn id="dedicatedworkerglobalscope">DedicatedWorkerGlobalScope</dfn> : <a href="#workerglobalscope">WorkerGlobalScope</a> {
1.318 ihickson 1402: void <a href="#dom-dedicatedworkerglobalscope-postmessage" title="dom-DedicatedWorkerGlobalScope-postMessage">postMessage</a>(any message, optional sequence<<span>Transferable</span>> transfer);
1.332 ihickson 1403: attribute <span>EventHandler</span> <a href="#handler-dedicatedworkerglobalscope-onmessage" title="handler-DedicatedWorkerGlobalScope-onmessage">onmessage</a>;
1.327 ihickson 1404: };</pre>
1405:
1.338 ihickson 1406: <p>The <code><a href="#dedicatedworkerglobalscope">DedicatedWorkerGlobalScope</a></code> interface must only
1407: be <span title="expose">exposed</span> if the <span>JavaScript
1408: global environment</span> is a <span>dedicated worker
1409: environment</span>.</p>
1.327 ihickson 1410:
1411: <p><code><a href="#dedicatedworkerglobalscope">DedicatedWorkerGlobalScope</a></code> objects act as if they
1.301 ihickson 1412: had an implicit <code><a href="#messageport">MessagePort</a></code> associated with them. This
1.81 ihickson 1413: port is part of a channel that is set up when the worker is created,
1414: but it is not exposed. This object must never be garbage collected
1.327 ihickson 1415: before the <code><a href="#dedicatedworkerglobalscope">DedicatedWorkerGlobalScope</a></code> object.</p>
1416:
1417: <p>All messages received by that port must immediately be retargeted
1418: at the <code><a href="#dedicatedworkerglobalscope">DedicatedWorkerGlobalScope</a></code> object.</p>
1419:
1420: <p>The <dfn id="dom-dedicatedworkerglobalscope-postmessage" title="dom-DedicatedWorkerGlobalScope-postMessage"><code>postMessage()</code></dfn>
1.318 ihickson 1421: method on
1.115 ihickson 1422: <code><a href="#dedicatedworkerglobalscope">DedicatedWorkerGlobalScope</a></code> objects must act as if, when
1.281 ihickson 1423: invoked, it immediately invoked the
1.81 ihickson 1424: method of the same name on the port, with the same arguments, and
1.327 ihickson 1425: returned the same return value.</p>
1426:
1427: <p>The following are the <span>event handlers</span> (and their
1.177 ihickson 1428: corresponding <span title="event handler event type">event handler
1429: event types</span>) that must be supported, as IDL attributes, by
1430: objects implementing the <code><a href="#dedicatedworkerglobalscope">DedicatedWorkerGlobalScope</a></code>
1.327 ihickson 1431: interface:</p>
1432:
1433: <table><thead><tr><th><span title="event handlers">Event handler</span> <th><span>Event handler event type</span>
1.155 ihickson 1434: <tbody><tr><td><dfn id="handler-dedicatedworkerglobalscope-onmessage" title="handler-DedicatedWorkerGlobalScope-onmessage"><code>onmessage</code></dfn> <td> <code title="event-message">message</code>
1.191 ihickson 1435: </table><p>For the purposes of the <span>application cache</span> networking
1436: model, a dedicated worker is an extension of the <span>cache
1.327 ihickson 1437: host</span> from which it was created.</p>
1438:
1439:
1440:
1441: <h4 id="shared-workers-and-the-sharedworkerglobalscope-interface"><span class="secno">4.2.3 </span>Shared workers and the <code><a href="#sharedworkerglobalscope">SharedWorkerGlobalScope</a></code> interface</h4>
1442:
1443: <pre class="idl">interface <dfn id="sharedworkerglobalscope">SharedWorkerGlobalScope</dfn> : <a href="#workerglobalscope">WorkerGlobalScope</a> {
1.115 ihickson 1444: readonly attribute DOMString <a href="#dom-sharedworkerglobalscope-name" title="dom-SharedWorkerGlobalScope-name">name</a>;
1.181 ihickson 1445: readonly attribute <span>ApplicationCache</span> <span title="dom-SharedWorkerGlobalScope-applicationCache">applicationCache</span>;
1.332 ihickson 1446: attribute <span>EventHandler</span> <a href="#handler-sharedworkerglobalscope-onconnect" title="handler-SharedWorkerGlobalScope-onconnect">onconnect</a>;
1.327 ihickson 1447: };</pre>
1448:
1.338 ihickson 1449: <p>The <code><a href="#sharedworkerglobalscope">SharedWorkerGlobalScope</a></code> interface must only be
1450: <span title="expose">exposed</span> if the <span>JavaScript global
1451: environment</span> is a <span>shared worker environment</span>.</p>
1.327 ihickson 1452:
1453: <p>Shared workers receive message ports through <code title="event-WorkerGlobalScope-connect">connect</code> events on
1454: their global object for each connection.</p>
1455:
1456: <p>The <dfn id="dom-sharedworkerglobalscope-name" title="dom-SharedWorkerGlobalScope-name"><code>name</code></dfn>
1.81 ihickson 1457: attribute must return the value it was assigned when the
1.115 ihickson 1458: <code><a href="#sharedworkerglobalscope">SharedWorkerGlobalScope</a></code> object was created by the
1459: "<a href="#run-a-worker">run a worker</a>" algorithm. Its value represents the name
1.81 ihickson 1460: that can be used to obtain a reference to the worker using the
1.327 ihickson 1461: <code><a href="#sharedworker">SharedWorker</a></code> constructor.</p>
1462:
1463: <p>The following are the <span>event handlers</span> (and their
1.177 ihickson 1464: corresponding <span title="event handler event type">event handler
1465: event types</span>) that must be supported, as IDL attributes, by
1466: objects implementing the <code><a href="#sharedworkerglobalscope">SharedWorkerGlobalScope</a></code>
1.327 ihickson 1467: interface:</p>
1468:
1469: <table><thead><tr><th><span title="event handlers">Event handler</span> <th><span>Event handler event type</span>
1.155 ihickson 1470: <tbody><tr><td><dfn id="handler-sharedworkerglobalscope-onconnect" title="handler-SharedWorkerGlobalScope-onconnect"><code>onconnect</code></dfn> <td> <code title="event-connect">connect</code>
1.191 ihickson 1471: </table><p>For the purposes of the <span>application cache</span> networking
1472: model, a shared worker is its own <span>cache host</span>. The
1473: <a href="#run-a-worker">run a worker</a> algorithm takes care of associating the
1.327 ihickson 1474: worker with an <span>application cache</span>.</p>
1475:
1476: <p class="note">The <code title="dom-SharedWorkerGlobalScope-applicationCache">applicationCache</code>
1.123 ihickson 1477: attribute returns the <code>ApplicationCache</code> object for the
1.327 ihickson 1478: worker.</p>
1479:
1480:
1.334 ihickson 1481:
1.339 ihickson 1482: <h3 id="the-event-loop"><span class="secno">4.3 </span>The event loop</h3>
1.327 ihickson 1483:
1484: <p>Each <code><a href="#workerglobalscope">WorkerGlobalScope</a></code> object has an <span>event
1.128 ihickson 1485: loop</span> distinct from those defined for <span title="unit of
1486: related similar-origin browsing contexts">units of related
1487: similar-origin browsing contexts</span>. This <span>event
1488: loop</span> has no associated <span>browsing context</span>, and its
1489: <span title="task queue">task queues</span> only have events,
1490: callbacks, and networking activity as <span title="concept-task">tasks</span>. The processing model of these
1491: <span title="event loop">event loops</span> is defined below in the
1.327 ihickson 1492: <a href="#run-a-worker">run a worker</a> algorithm.</p>
1493:
1494: <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
1.81 ihickson 1495: initially be false, but which can get set to true by the algorithms
1.327 ihickson 1496: in the processing model section below.</p>
1497:
1498: <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
1.81 ihickson 1499: true, the <span>event loop</span>'s <span title="task queue">task
1.115 ihickson 1500: queues</span> must discard any further <span title="concept-task">tasks</span> that would be added to them (tasks
1.175 ihickson 1501: already on the queue are unaffected except where otherwise
1.115 ihickson 1502: specified). Effectively, once the <a href="#dom-workerglobalscope-closing" title="dom-WorkerGlobalScope-closing">closing</a> flag is true,
1.81 ihickson 1503: timers stop firing, notifications for all pending asynchronous
1.327 ihickson 1504: operations are dropped, etc.</p>
1505:
1506:
1507:
1.339 ihickson 1508: <h3 id="the-worker-s-lifetime"><span class="secno">4.4 </span>The worker's lifetime</h3>
1.327 ihickson 1509:
1510: <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
1511: <code><a href="#messageport">MessagePort</a></code> objects.</p>
1512:
1513: <p>Each <code><a href="#workerglobalscope">WorkerGlobalScope</a></code> <var title="">worker global
1.124 ihickson 1514: scope</var> has a list of <dfn id="the-worker-s-ports">the worker's ports</dfn>, which
1.301 ihickson 1515: consists of all the <code><a href="#messageport">MessagePort</a></code> objects that are
1.81 ihickson 1516: entangled with another port and that have one (but only one) port
1517: owned by <var title="">worker global scope</var>. This list includes
1.281 ihickson 1518: the implicit
1.327 ihickson 1519: <code><a href="#messageport">MessagePort</a></code> in the case of <a href="#dedicatedworkerglobalscope" title="DedicatedWorkerGlobalScope">dedicated workers</a>.</p>
1520:
1521: <p>Each <code><a href="#workerglobalscope">WorkerGlobalScope</a></code> also has a list of <dfn id="the-worker-s-workers">the
1.124 ihickson 1522: worker's workers</dfn>. Initially this list is empty; it is
1.327 ihickson 1523: populated when the worker creates or obtains further workers.</p>
1524:
1525: <p>Finally, each <code><a href="#workerglobalscope">WorkerGlobalScope</a></code> also has a list of
1.124 ihickson 1526: <dfn id="the-worker-s-documents">the worker's <code>Document</code>s</dfn>. Initially this list
1.327 ihickson 1527: is empty; it is populated when the worker is created.</p>
1528:
1529: <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
1.123 ihickson 1530: worker's <code>Document</code>s</dfn>, the user agent must, for each
1.325 ihickson 1531: worker <var title="">q</var> in the list of <a href="#the-worker-s-workers">the worker's
1532: workers</a> whose list of <a href="#the-worker-s-documents">the worker's
1533: <code>Document</code>s</a> does not contain <var title="">d</var>, <a href="#add-a-document-to-the-worker-s-documents" title="add a document to the worker's
1.123 ihickson 1534: documents">add <var title="">d</var> to <var title="">q</var>'s
1535: <code>WorkerGlobalScope</code> owner's list of <span>the worker's
1.327 ihickson 1536: <code>Document</code>s</span></a>.</p>
1537:
1538: <p>Whenever a <code>Document</code> object is <span title="discard a
1.123 ihickson 1539: Document">discarded</span>, it must be removed from the list of
1540: <a href="#the-worker-s-documents">the worker's <code>Document</code>s</a> of each worker
1.327 ihickson 1541: whose list contains that <code>Document</code>.</p>
1542:
1543: <p>Given a <span>script's global object</span> <var title="">o</var>
1.123 ihickson 1544: when creating or obtaining a worker, the <dfn id="list-of-relevant-document-objects-to-add">list of relevant
1545: <code>Document</code> objects to add</dfn> depends on the type of
1546: <var title="">o</var>. If <var title="">o</var> is a
1547: <code><a href="#workerglobalscope">WorkerGlobalScope</a></code> object (i.e. if we are creating a
1548: nested worker), then the relevant <code>Document</code>s are the
1549: <code>Document</code>s that are in <var title="">o</var>'s own list
1550: 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
1551: <code>Document</code> is just the <code>Document</code> that is the
1.327 ihickson 1552: <span>active document</span> of the <code>Window</code> object <var title="">o</var>.</p>
1553:
1554: <hr><p>A worker is said to be a <dfn id="permissible-worker">permissible worker</dfn> if its
1.123 ihickson 1555: list of <a href="#the-worker-s-documents">the worker's <code>Document</code>s</a> is not
1.327 ihickson 1556: empty.</p>
1557:
1558: <p>A worker is said to be a <dfn id="protected-worker">protected worker</dfn> if it is a
1.123 ihickson 1559: <a href="#permissible-worker">permissible worker</a> and either it has outstanding
1560: timers, database transactions, or network connections, or its list
1.124 ihickson 1561: of <a href="#the-worker-s-ports">the worker's ports</a> is not empty, or its
1.123 ihickson 1562: <code><a href="#workerglobalscope">WorkerGlobalScope</a></code> is actually a
1563: <code><a href="#sharedworkerglobalscope">SharedWorkerGlobalScope</a></code> object (i.e. the worker is a
1.327 ihickson 1564: shared worker).</p>
1565:
1566: <p>A worker is said to be an <dfn id="active-needed-worker">active needed worker</dfn> if any
1.123 ihickson 1567: of the <code>Document</code> objects in <a href="#the-worker-s-documents">the worker's
1.327 ihickson 1568: <code>Document</code>s</a> are <span>fully active</span>.</p>
1569:
1570: <p>A worker is said to be a <dfn id="suspendable-worker">suspendable worker</dfn> if it is
1.123 ihickson 1571: not an <a href="#active-needed-worker">active needed worker</a> but it is a
1.327 ihickson 1572: <a href="#permissible-worker">permissible worker</a>.</p>
1573:
1574:
1.339 ihickson 1575: <h3 id="processing-model"><span class="secno">4.5 </span>Processing model</h3>
1.327 ihickson 1576:
1577: <p>When a user agent is to <dfn id="run-a-worker">run a worker</dfn> for a script with
1.232 ihickson 1578: <span>URL</span> <var title="">url</var>, a <span>browsing
1579: context</span> <var title="">owner browsing context</var>, a
1580: <code>Document</code> <var title="">owner document</var>, an
1581: <span>origin</span> <var title="">owner origin</var>, and with
1582: global scope <var title="">worker global scope</var>, it must run
1.327 ihickson 1583: the following steps:</p>
1584:
1585: <ol><li>
1.81 ihickson 1586:
1.274 ihickson 1587: <p>Create a separate parallel execution environment (i.e. a
1588: separate thread or process or equivalent construct), and run the
1589: rest of these steps asynchronously in that context.</p>
1.81 ihickson 1590:
1591: </li>
1.4 ihickson 1592:
1.101 ihickson 1593: <li><p>If <var title="">worker global scope</var> is actually a
1.115 ihickson 1594: <code><a href="#sharedworkerglobalscope">SharedWorkerGlobalScope</a></code> object (i.e. the worker is a
1.101 ihickson 1595: shared worker), and there are any <span title="relevant application
1596: cache">relevant application caches</span> that are identified by a
1597: manifest URL with the <span>same origin</span> as <var title="">url</var> and that have <var title="">url</var> as one of
1.115 ihickson 1598: their entries, <em>not</em> excluding entries marked as <span title="concept-appcache-foreign">foreign</span>, then associate the
1599: <var title="">worker global scope</var> with the <span title="concept-appcache-selection">most appropriate application
1.101 ihickson 1600: cache</span> of those that match.</li>
1601:
1.4 ihickson 1602: <li>
1.52 ihickson 1603:
1.341 ihickson 1604: <p>Attempt to <span>fetch</span> the resource
1605: identified by <var title="">url</var>, from the <var title="">owner origin</var>, using <var title="">owner
1606: document</var> as the <span>referrer source</span>, with the
1607: <i>synchronous flag</i> set and the <i>force same-origin flag</i>
1608: set.</p>
1.318 ihickson 1609:
1.256 ihickson 1610: <p>If the attempt fails, then for each <code><a href="#worker">Worker</a></code> or
1611: <code><a href="#sharedworker">SharedWorker</a></code> object associated with <var title="">worker global scope</var>, <span>queue a task</span> to
1612: <span>fire a simple event</span> named <code title="event-error">error</code> at that object. Abort these
1613: steps.</p>
1.7 ihickson 1614:
1.264 ihickson 1615: <p>If the attempt succeeds, then let <var title="">source</var> be
1616: the script resource <span>decoded as UTF-8, with error
1617: handling</span>.
1618:
1619: <a href="#refsHTML">[HTML]</a>
1620:
1621: </p>
1.81 ihickson 1622:
1.68 ihickson 1623: <p>Let <var title="">language</var> be JavaScript.</p>
1.7 ihickson 1624:
1.115 ihickson 1625: <p class="note">As with <code>script</code> elements, the MIME
1.81 ihickson 1626: type of the script is ignored. Unlike with <code>script</code>
1627: elements, there is no way to override the type. It's always
1.170 ihickson 1628: assumed to be JavaScript.</p>
1.81 ihickson 1629:
1630: </li>
1.7 ihickson 1631:
1.338 ihickson 1632: <li><p>In the newly created execution environment, create a
1633: <span>JavaScript global environment</span> whose <i>global
1634: object</i> is <var title="">worker global scope</var>. If <var title="">worker global scope</var> is a
1635: <code><a href="#dedicatedworkerglobalscope">DedicatedWorkerGlobalScope</a></code> object, then this is a
1636: <span>dedicated worker environment</span>. Otherwise, <var title="">worker global scope</var> is a
1637: <code><a href="#sharedworkerglobalscope">SharedWorkerGlobalScope</a></code> object, and this is a
1638: <span>shared worker environment</span>. (In either case, by
1639: definition, it is a <span>worker environment</span>.)</li>
1640:
1.7 ihickson 1641: <li>
1.68 ihickson 1642:
1.115 ihickson 1643: <p>A new <span title="concept-script">script</span> is now
1.81 ihickson 1644: created, as follows.</p>
1645:
1646: <p>Create a new <span>script execution environment</span>
1647: set up as appropriate for the scripting language <var title="">language</var>.</p>
1.34 ihickson 1648:
1.68 ihickson 1649: <p>Parse/compile/initialize <var title="">source</var> using that
1.81 ihickson 1650: <span>script execution environment</span>, as appropriate for <var title="">language</var>, and thus obtain a <span>list of code
1651: entry-points</span>; set the <i>initial code entry-point</i> to
1652: the entry-point for any executable code to be immediately run.</p>
1653:
1654: <p>Set the <span>script's global object</span> to <var title="">worker global scope</var>.</p>
1655:
1656: <p>Set the <span>script's browsing context</span> to <var title="">owner browsing context</var>.</p>
1657:
1.232 ihickson 1658: <p>Set the <span>script's document</span> to <var title="">owner
1659: document</var>.</p>
1660:
1.341 ihickson 1661: <p>Set the <span>script's referrer source</span> to <var title="">url</var>.</p>
1662:
1.83 ihickson 1663: <p>Set the <span>script's URL character encoding</span> to
1.81 ihickson 1664: UTF-8. (This is just used for encoding non-ASCII characters in the
1665: query component of URLs.)</p>
1.68 ihickson 1666:
1667: <p>Set the <span>script's base URL</span> to <var title="">url</var>.</p>
1.4 ihickson 1668:
1.81 ihickson 1669: </li>
1.4 ihickson 1670:
1671: <li>
1.81 ihickson 1672:
1673: <p><strong>Closing orphan workers</strong>: Start monitoring the
1.125 ihickson 1674: worker such that no sooner than it stops being either a
1675: <a href="#protected-worker">protected worker</a> or a <a href="#suspendable-worker">suspendable
1.123 ihickson 1676: worker</a>, and no later than it stops being a
1677: <a href="#permissible-worker">permissible worker</a>, <var title="">worker global
1678: scope</var>'s <a href="#dom-workerglobalscope-closing" title="dom-WorkerGlobalScope-closing">closing</a> flag is set
1.281 ihickson 1679: to true.</p>
1.81 ihickson 1680:
1681: </li>
1.9 ihickson 1682:
1683: <li>
1.7 ihickson 1684:
1.81 ihickson 1685: <p><strong>Suspending workers</strong>: Start monitoring the
1686: worker, such that whenever <var title="">worker global
1.115 ihickson 1687: scope</var>'s <a href="#dom-workerglobalscope-closing" title="dom-WorkerGlobalScope-closing">closing</a> flag is false
1688: and the worker is a <a href="#suspendable-worker">suspendable worker</a>, the user
1.81 ihickson 1689: agent suspends execution of script in that worker until such time
1.115 ihickson 1690: as either the <a href="#dom-workerglobalscope-closing" title="dom-WorkerGlobalScope-closing">closing</a> flag switches
1691: to true or the worker stops being a <a href="#suspendable-worker">suspendable
1.81 ihickson 1692: worker</a>.</p>
1.4 ihickson 1693:
1.81 ihickson 1694: </li>
1.68 ihickson 1695:
1696: <li>
1.4 ihickson 1697:
1.81 ihickson 1698: <p><span title="jump to a code entry-point">Jump</span> to the
1.115 ihickson 1699: <span title="concept-script">script</span>'s <i>initial code
1.81 ihickson 1700: entry-point</i>, and let that run until it either returns, fails
1701: to catch an exception, or gets prematurely aborted by the
1.115 ihickson 1702: "<a href="#kill-a-worker">kill a worker</a>" or "<a href="#terminate-a-worker">terminate a worker</a>"
1.81 ihickson 1703: algorithms defined below.</p>
1704:
1.4 ihickson 1705:
1.318 ihickson 1706:
1.81 ihickson 1707: </li>
1.4 ihickson 1708:
1.95 ihickson 1709: <li><p>If <var title="">worker global scope</var> is actually a
1.115 ihickson 1710: <code><a href="#dedicatedworkerglobalscope">DedicatedWorkerGlobalScope</a></code> object (i.e. the worker is
1.126 ihickson 1711: a dedicated worker), then enable the <span>port message
1712: queue</span> of the worker's implicit port.</li>
1.95 ihickson 1713:
1.4 ihickson 1714: <li>
1.68 ihickson 1715:
1.115 ihickson 1716: <p><i title="">Event loop</i>: Wait until either there is a <span title="concept-task">task</span> in one of the <span>event
1717: 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
1.81 ihickson 1718: to true.</p>
1.43 ihickson 1719:
1.81 ihickson 1720: </li>
1.4 ihickson 1721:
1722: <li>
1723:
1.81 ihickson 1724: <p>Run the oldest task on one of the <span>event loop</span>'s
1725: <span title="task queue">task queues</span>, if any. The user
1726: agent may pick any <span>task queue</span>.</p>
1727:
1.115 ihickson 1728: <p class="note">The handling of events or the execution of
1729: callbacks might get prematurely aborted by the "<a href="#kill-a-worker">kill a
1730: worker</a>" or "<a href="#terminate-a-worker">terminate a worker</a>" algorithms
1.81 ihickson 1731: defined below.</p>
1.8 ihickson 1732:
1.81 ihickson 1733: </li>
1.4 ihickson 1734:
1735: <li>
1736:
1.248 ihickson 1737: <p>If the <span>storage mutex</span> is now owned by the worker's
1738: <span>event loop</span>, release it so that it is once again
1739: free.</p>
1740:
1741: </li>
1742:
1743: <li>
1744:
1745: <p>Remove the task just run in the earlier step, if any, from its
1.81 ihickson 1746: <span>task queue</span>.</p>
1.4 ihickson 1747:
1.81 ihickson 1748: </li>
1.4 ihickson 1749:
1750: <li>
1.8 ihickson 1751:
1.81 ihickson 1752: <p>If there are any more events in the <span>event loop</span>'s
1.115 ihickson 1753: <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
1.81 ihickson 1754: to false, then jump back to the step above labeled <i>event
1755: loop</i>.</p>
1.8 ihickson 1756:
1.81 ihickson 1757: </li>
1.8 ihickson 1758:
1759: <li>
1.71 ihickson 1760:
1.123 ihickson 1761: <p>Empty the <var title="">worker global scope</var>'s <span>list
1.333 ihickson 1762: of active timers</span>.</p>
1.50 ihickson 1763:
1.81 ihickson 1764: </li>
1.50 ihickson 1765:
1.247 ihickson 1766: <li>
1767:
1768: <p>Disentangle all the ports in the list of <a href="#the-worker-s-ports">the worker's
1769: ports</a>.</p>
1770:
1771: </li>
1772:
1.318 ihickson 1773:
1.155 ihickson 1774: </ol><hr><p>When a user agent is to <dfn id="kill-a-worker">kill a worker</dfn> it must
1.81 ihickson 1775: run the following steps in parallel with the worker's main loop (the
1.327 ihickson 1776: "<a href="#run-a-worker">run a worker</a>" processing model defined above):</p>
1777:
1778: <ol><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
1.81 ihickson 1779: true.</li>
1780:
1781:
1.318 ihickson 1782:
1.115 ihickson 1783: <li><p>If there are any <span title="concept-task">tasks</span>
1.81 ihickson 1784: queued in the <span>event loop</span>'s <span title="task
1.281 ihickson 1785: queue">task queues</span>, discard them without processing them.</li>
1786:
1.81 ihickson 1787:
1.318 ihickson 1788:
1.81 ihickson 1789: <li><p>Wait a user-agent-defined amount of time.</li>
1790:
1.281 ihickson 1791: <li><p>Abort the script currently running in the worker.</li>
1.81 ihickson 1792:
1.155 ihickson 1793: </ol><p>User agents may invoke the "<a href="#kill-a-worker">kill a worker</a>"
1.81 ihickson 1794: processing model on a worker at any time, e.g. in response to user
1795: requests, in response to CPU quota management, or when a worker
1.115 ihickson 1796: stops being an <a href="#active-needed-worker">active needed worker</a> if the worker
1797: continues executing even after its <a href="#dom-workerglobalscope-closing" title="dom-WorkerGlobalScope-closing">closing</a> flag was
1.327 ihickson 1798: set to true.</p>
1799:
1800: <hr><p>When a user agent is to <dfn id="terminate-a-worker">terminate a worker</dfn> it must run
1.81 ihickson 1801: the following steps in parallel with the worker's main loop (the
1.327 ihickson 1802: "<a href="#run-a-worker">run a worker</a>" processing model defined above):</p>
1803:
1804: <ol><li><p>Set the worker's <code><a href="#workerglobalscope">WorkerGlobalScope</a></code> object's
1.115 ihickson 1805: <a href="#dom-workerglobalscope-closing" title="dom-WorkerGlobalScope-closing">closing</a> flag to
1.81 ihickson 1806: true.</li>
1807:
1.115 ihickson 1808: <li><p>If there are any <span title="concept-task">tasks</span>
1.81 ihickson 1809: queued in the <span>event loop</span>'s <span title="task
1810: queue">task queues</span>, discard them without processing
1811: them.</li>
1812:
1813: <li><p>Abort the script currently running in the worker.</li>
1814:
1.115 ihickson 1815: <li><p>If the worker's <code><a href="#workerglobalscope">WorkerGlobalScope</a></code> object is
1816: actually a <code><a href="#dedicatedworkerglobalscope">DedicatedWorkerGlobalScope</a></code> object (i.e. the
1.81 ihickson 1817: worker is a dedicated worker), then empty the <span>port message
1818: queue</span> of the port that the worker's implicit port is
1819: entangled with.</li>
1820:
1.155 ihickson 1821: </ol><hr><p>The <span>task source</span> for the tasks mentioned above is the
1.327 ihickson 1822: <span>DOM manipulation task source</span>.</p>
1823:
1824:
1.339 ihickson 1825: <h3 id="runtime-script-errors"><span class="secno">4.6 </span>Runtime script errors</h3>
1.327 ihickson 1826:
1827: <p>Whenever an uncaught runtime script error occurs in one of the
1.143 ihickson 1828: worker's scripts, if the error did not occur while handling a
1829: previous script error, the user agent must <span>report the
1.314 ihickson 1830: error</span> at the <span>URL</span> of the resource that contained
1.324 ihickson 1831: the script, with the position (line number and column number) where
1832: the error occurred, in the <span>origin</span> of the scripts
1833: running in the worker, using the <code><a href="#workerglobalscope">WorkerGlobalScope</a></code>
1834: object's <code title="handler-WorkerGlobalScope-onerror"><a href="#handler-workerglobalscope-onerror">onerror</a></code> attribute.
1.205 ihickson 1835:
1.226 ihickson 1836: <a href="#refsHTML">[HTML]</a>
1.205 ihickson 1837:
1.327 ihickson 1838: </p>
1839:
1.205 ihickson 1840: <p>For shared workers, if the error is still <i title="concept-error-nothandled">not handled</i> afterwards, or if
1.132 ihickson 1841: the error occurred while handling a previous script error, the error
1.215 ihickson 1842: may be reported to the user.
1.205 ihickson 1843:
1.226 ihickson 1844: <a href="#refsHTML">[HTML]</a>
1.205 ihickson 1845:
1.327 ihickson 1846: </p>
1847:
1.205 ihickson 1848: <p>For dedicated workers, if the error is still <i title="concept-error-nothandled">not handled</i> afterwards, or if
1.132 ihickson 1849: the error occurred while handling a previous script error, the user
1.292 ihickson 1850: agent must <span>queue a task</span> to fire an event that uses the
1851: <code><a href="#errorevent">ErrorEvent</a></code> interface, with the name <code title="event-error">error</code>, that doesn't bubble and is
1.343 ihickson 1852: 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>, <code title="dom-ErrorEvent-lineno"><a href="#dom-errorevent-lineno">lineno</a></code>, and <code title="dom-ErrorEvent-column"><a href="#dom-errorevent-column">column</a></code> attributes initialized
1.292 ihickson 1853: appropriately, at the <code><a href="#worker">Worker</a></code> object associated with the
1.307 ihickson 1854: worker. If the event is not canceled, the user agent must act as if
1855: the uncaught runtime script error had occurred in the global scope
1856: that the <code><a href="#worker">Worker</a></code> object is in, thus repeating the entire
1.327 ihickson 1857: runtime script error reporting process one level up.</p>
1858:
1859: <p>If the implicit port connecting the worker to its
1.292 ihickson 1860: <code><a href="#worker">Worker</a></code> object has been disentangled (i.e. if the parent
1861: worker has been terminated), then the user agent must act as if the
1862: <code><a href="#worker">Worker</a></code> object had no <code title="event-error">error</code> event handler and as if that
1863: worker's <code title="handler-WorkerGlobalScope-onerror"><a href="#handler-workerglobalscope-onerror">onerror</a></code> attribute
1.327 ihickson 1864: was null, but must otherwise act as described above.</p>
1865:
1.331 ihickson 1866: <p class="note">Thus, error reports propagate up to the chain of
1.292 ihickson 1867: dedicated workers up to the original <code>Document</code>, even if
1868: some of the workers along this chain have been terminated and
1.327 ihickson 1869: garbage collected.</p>
1870:
1871: <p>The <span>task source</span> for the task mentioned above is the
1872: <span>DOM manipulation task source</span>.</p>
1873:
1874: <hr><pre class="idl">[Constructor(DOMString type, optional <a href="#erroreventinit">ErrorEventInit</a> eventInitDict)]
1.307 ihickson 1875: interface <dfn id="errorevent">ErrorEvent</dfn> : <span>Event</span> {
1.147 ihickson 1876: readonly attribute DOMString <a href="#dom-errorevent-message" title="dom-ErrorEvent-message">message</a>;
1877: readonly attribute DOMString <a href="#dom-errorevent-filename" title="dom-ErrorEvent-filename">filename</a>;
1.115 ihickson 1878: readonly attribute unsigned long <a href="#dom-errorevent-lineno" title="dom-ErrorEvent-lineno">lineno</a>;
1.343 ihickson 1879: readonly attribute unsigned long <a href="#dom-errorevent-column" title="dom-ErrorEvent-column">column</a>;
1.307 ihickson 1880: };
1881:
1882: dictionary <dfn id="erroreventinit">ErrorEventInit</dfn> : <span>EventInit</span> {
1883: DOMString message;
1884: DOMString filename;
1885: unsigned long lineno;
1.343 ihickson 1886: unsigned long column;
1.327 ihickson 1887: };</pre>
1888:
1889: <p>The <dfn id="dom-errorevent-message" title="dom-ErrorEvent-message"><code>message</code></dfn> attribute
1.307 ihickson 1890: must return the value it was initialized to. When the object is
1891: created, this attribute must be initialized to the empty string. It
1.327 ihickson 1892: represents the error message.</p>
1893:
1894: <p>The <dfn id="dom-errorevent-filename" title="dom-ErrorEvent-filename"><code>filename</code></dfn>
1.307 ihickson 1895: attribute must return the value it was initialized to. When the
1896: object is created, this attribute must be initialized to the empty
1897: string. It represents the <span>absolute URL</span> of the script in
1.327 ihickson 1898: which the error originally occurred.</p>
1899:
1900: <p>The <dfn id="dom-errorevent-lineno" title="dom-ErrorEvent-lineno"><code>lineno</code></dfn>
1.307 ihickson 1901: attribute must return the value it was initialized to. When the
1902: object is created, this attribute must be initialized to zero. It
1903: represents the line number where the error occurred in the
1.327 ihickson 1904: script.</p>
1905:
1.343 ihickson 1906: <p>The <dfn id="dom-errorevent-column" title="dom-ErrorEvent-column"><code>column</code></dfn>
1907: attribute must return the value it was initialized to. When the
1908: object is created, this attribute must be initialized to zero. It
1909: represents the column number where the error occurred in the
1910: script.</p>
1911:
1.327 ihickson 1912:
1913:
1.339 ihickson 1914: <h3 id="creating-workers"><span class="secno">4.7 </span>Creating workers</h3>
1.327 ihickson 1915:
1.339 ihickson 1916: <h4 id="the-abstractworker-abstract-interface"><span class="secno">4.7.1 </span>The <code><a href="#abstractworker">AbstractWorker</a></code> abstract interface</h4>
1.327 ihickson 1917:
1918: <pre class="idl">[NoInterfaceObject]
1.317 ihickson 1919: interface <dfn id="abstractworker">AbstractWorker</dfn> {
1.332 ihickson 1920: attribute <span>EventHandler</span> <a href="#handler-abstractworker-onerror" title="handler-AbstractWorker-onerror">onerror</a>;
1.318 ihickson 1921:
1.327 ihickson 1922: };</pre>
1923:
1924: <p>The following are the <span>event handlers</span> (and their
1.177 ihickson 1925: corresponding <span title="event handler event type">event handler
1926: event types</span>) that must be supported, as IDL attributes, by
1.327 ihickson 1927: objects implementing the <code><a href="#abstractworker">AbstractWorker</a></code> interface:</p>
1928:
1929: <table><thead><tr><th><span title="event handlers">Event handler</span> <th><span>Event handler event type</span>
1.155 ihickson 1930: <tbody><tr><td><dfn id="handler-abstractworker-onerror" title="handler-AbstractWorker-onerror"><code>onerror</code></dfn> <td> <code title="event-error">error</code>
1.318 ihickson 1931:
1.339 ihickson 1932: </table><h4 id="dedicated-workers-and-the-worker-interface"><span class="secno">4.7.2 </span>Dedicated workers and the <code><a href="#worker">Worker</a></code> interface</h4>
1.327 ihickson 1933:
1934: <pre class="idl">[<a href="#dom-worker" title="dom-Worker">Constructor</a>(DOMString scriptURL)]
1.317 ihickson 1935: interface <dfn id="worker">Worker</dfn> : <span>EventTarget</span> {
1.115 ihickson 1936: void <a href="#dom-worker-terminate" title="dom-Worker-terminate">terminate</a>();
1.50 ihickson 1937:
1.318 ihickson 1938: void <a href="#dom-worker-postmessage" title="dom-Worker-postMessage">postMessage</a>(any message, optional sequence<<span>Transferable</span>> transfer);
1.332 ihickson 1939: attribute <span>EventHandler</span> <a href="#handler-worker-onmessage" title="handler-Worker-onmessage">onmessage</a>;
1.317 ihickson 1940: };
1.327 ihickson 1941: <a href="#worker">Worker</a> implements <a href="#abstractworker">AbstractWorker</a>;</pre>
1942:
1943: <p>The <dfn id="dom-worker-terminate" title="dom-Worker-terminate"><code>terminate()</code></dfn> method,
1.115 ihickson 1944: when invoked, must cause the "<a href="#terminate-a-worker">terminate a worker</a>"
1.81 ihickson 1945: algorithm to be run on the worker with with the object is
1.327 ihickson 1946: associated.</p>
1947:
1948: <p><code><a href="#worker">Worker</a></code> objects act as if they had an implicit
1.301 ihickson 1949: <code><a href="#messageport">MessagePort</a></code> associated with them. This port is part of
1.81 ihickson 1950: a channel that is set up when the worker is created, but it is not
1951: exposed. This object must never be garbage collected before the
1.327 ihickson 1952: <code><a href="#worker">Worker</a></code> object.</p>
1953:
1954: <p>All messages received by that port must immediately be retargeted
1955: at the <code><a href="#worker">Worker</a></code> object.</p>
1956:
1957: <p>The <dfn id="dom-worker-postmessage" title="dom-Worker-postMessage"><code>postMessage()</code></dfn>
1.318 ihickson 1958: method on <code><a href="#worker">Worker</a></code> objects
1.281 ihickson 1959: must act as if, when invoked, it
1.81 ihickson 1960: immediately invoked the method of the same name on the port, with
1.327 ihickson 1961: the same arguments, and returned the same return value.</p>
1962:
1963: <div class="example">
1.319 ihickson 1964:
1965: <p>The <code title="dom-Worker-postMessage"><a href="#dom-worker-postmessage">postMessage()</a></code>
1966: method's first argument can be structured data:</p>
1967:
1968: <pre>worker.postMessage({opcode: 'activate', device: 1938, parameters: [23, 102]});</pre>
1969:
1.327 ihickson 1970: </div>
1971:
1972: <p>The following are the <span>event handlers</span> (and their
1.177 ihickson 1973: corresponding <span title="event handler event type">event handler
1974: event types</span>) that must be supported, as IDL attributes, by
1.327 ihickson 1975: objects implementing the <code><a href="#worker">Worker</a></code> interface:</p>
1976:
1977: <table><thead><tr><th><span title="event handlers">Event handler</span> <th><span>Event handler event type</span>
1.155 ihickson 1978: <tbody><tr><td><dfn id="handler-worker-onmessage" title="handler-Worker-onmessage"><code>onmessage</code></dfn> <td> <code title="event-message">message</code>
1979: </table><hr><p>When the <dfn id="dom-worker" title="dom-Worker"><code>Worker(<var title="">scriptURL</var>)</code></dfn> constructor is invoked, the
1.327 ihickson 1980: user agent must run the following steps:</p>
1981:
1982: <ol><li><p><span title="resolve a url">Resolve</span> the <var title="">scriptURL</var> argument relative to the <span>entry
1.133 ihickson 1983: script</span>'s <span title="script's base URL">base URL</span>,
1984: when the method is invoked.</li>
1.9 ihickson 1985:
1.309 ihickson 1986: <li><p>If this fails, throw a <code>SyntaxError</code>
1.81 ihickson 1987: exception.</li>
1.9 ihickson 1988:
1.167 ihickson 1989: <li>
1990:
1.339 ihickson 1991: <p>If the <span title="url-scheme"><scheme></span> component of
1992: the resulting <span>absolute URL</span> is not "<code title="data-protocol">data</code>", and the <span>origin</span> of
1993: the resulting <span>absolute URL</span> is not the <span title="same origin">same</span> as the origin of the <span>entry
1994: script</span>, then throw a <code>SecurityError</code> exception
1995: and abort these steps.</p>
1.167 ihickson 1996:
1.334 ihickson 1997: <p class="note">Thus, scripts must either be external files with
1.339 ihickson 1998: the same scheme, host, and port as the original page, or <span title="data protocol"><code title="">data:</code> URLs</span>. For
1999: example, you can't load a script from a <span title="javascript
2000: protocol"><code title="">javascript:</code> URL</span>, and an
2001: <code>http:</code> page couldn't start workers using scripts with
2002: <code>http:</code> URLs.</p>
1.167 ihickson 2003:
2004: </li>
1.9 ihickson 2005:
1.339 ihickson 2006: <li><p>Create a new <code><a href="#dedicatedworkerglobalscope">DedicatedWorkerGlobalScope</a></code> object
2007: whose <a href="#worker-origin">worker origin</a> is the origin of the <span>entry
2008: script</span>. Let <var title="">worker global scope</var> be this
2009: new object.</li>
1.9 ihickson 2010:
1.115 ihickson 2011: <li><p>Create a new <code><a href="#worker">Worker</a></code> object, associated with
1.81 ihickson 2012: <var title="">worker global scope</var>. Let <var title="">worker</var> be this new object.</li>
1.50 ihickson 2013:
1.301 ihickson 2014: <li><p><span>Create a new <code><a href="#messageport">MessagePort</a></code> object</span>
1.192 ihickson 2015: owned by the <span title="script's global object">global
2016: object</span> of the <span title="concept-script">script</span> that
1.185 ihickson 2017: invoked the constructor. Let this be the <var title="">outside
1.81 ihickson 2018: port</var>.</li>
1.9 ihickson 2019:
1.81 ihickson 2020: <li><p>Associate the <var title="">outside port</var> with <var title="">worker</var>.</li>
1.50 ihickson 2021:
1.301 ihickson 2022: <li><p><span>Create a new <code><a href="#messageport">MessagePort</a></code> object</span>
1.185 ihickson 2023: owned by <var title="">worker global scope</var>. Let <var title="">inside port</var> be this new object.</li>
1.50 ihickson 2024:
1.81 ihickson 2025: <li><p>Associate <var title="">inside port</var> with <var title="">worker global scope</var>.</li>
1.50 ihickson 2026:
1.81 ihickson 2027: <li><p><span>Entangle</span> <var title="">outside port</var> and
2028: <var title="">inside port</var>.</li>
1.50 ihickson 2029:
1.81 ihickson 2030: <li><p>Return <var title="">worker</var>, and run the following
2031: steps asynchronously.</li>
1.50 ihickson 2032:
2033:
1.318 ihickson 2034:
1.126 ihickson 2035: <li><p>Enable <var title="">outside port</var>'s <span>port message
1.81 ihickson 2036: queue</span>.</li>
1.50 ihickson 2037:
2038: <li>
1.51 ihickson 2039:
1.123 ihickson 2040: <p>Let <var title="">docs</var> be the <a href="#list-of-relevant-document-objects-to-add">list of relevant
1.192 ihickson 2041: <code>Document</code> objects to add</a> given the <span title="script's global object">global object</span> of the <span title="concept-script">script</span> that invoked the
1.123 ihickson 2042: constructor.</p>
2043:
2044: </li>
2045:
2046: <li>
2047:
2048: <p><a href="#add-a-document-to-the-worker-s-documents" title="add a document to the worker's documents">Add to
2049: <var title="">worker global scope</var>'s list of <span>the
2050: worker's <code>Document</code>s</span></a> the
2051: <code>Document</code> objects in <var title="">docs</var>.</p>
2052:
2053: </li>
2054:
2055: <li>
2056:
1.192 ihickson 2057: <p>If the <span title="script's global object">global object</span>
1.124 ihickson 2058: of the <span title="concept-script">script</span> that invoked the
2059: constructor is a <code><a href="#workerglobalscope">WorkerGlobalScope</a></code> object (i.e. we
2060: are creating a nested worker), add <var title="">worker global
2061: scope</var> to the list of <a href="#the-worker-s-workers">the worker's workers</a> of the
1.192 ihickson 2062: <code><a href="#workerglobalscope">WorkerGlobalScope</a></code> object that is the <span title="script's global object">global object</span> of the <span title="concept-script">script</span> that invoked the
1.124 ihickson 2063: constructor.</p>
2064:
2065: </li>
2066:
2067: <li>
2068:
1.115 ihickson 2069: <p><a href="#run-a-worker">Run a worker</a> for the resulting <span>absolute
1.193 ihickson 2070: URL</span>, with the <span>script's browsing context</span> of the
1.81 ihickson 2071: script that invoked the method as the <var title="">owner browsing
1.232 ihickson 2072: context</var>, with the <span>script's document</span> of the
2073: script that invoked the method as the <var title="">owner
2074: document</var>, with the <span>origin</span> of the <span>entry
1.176 ihickson 2075: script</span> as the <var title="">owner origin</var>, and with
2076: <var title="">worker global scope</var> as the global scope.</p>
1.9 ihickson 2077:
1.81 ihickson 2078: </li>
1.4 ihickson 2079:
1.155 ihickson 2080: </ol><p>This constructor must be visible when the <span>script's global
1.192 ihickson 2081: object</span> is either a <code>Window</code> object or an object
1.327 ihickson 2082: implementing the <code><a href="#workerutils">WorkerUtils</a></code> interface.</p>
2083:
2084:
1.339 ihickson 2085: <h4 id="shared-workers-and-the-sharedworker-interface"><span class="secno">4.7.3 </span>Shared workers and the <code><a href="#sharedworker">SharedWorker</a></code> interface</h4>
1.327 ihickson 2086:
2087: <pre class="idl">[<a href="#dom-sharedworker" title="dom-SharedWorker">Constructor</a>(DOMString scriptURL, optional DOMString name)]
1.317 ihickson 2088: interface <dfn id="sharedworker">SharedWorker</dfn> : <span>EventTarget</span> {
1.301 ihickson 2089: readonly attribute <a href="#messageport">MessagePort</a> <a href="#dom-sharedworker-port" title="dom-SharedWorker-port">port</a>;
1.317 ihickson 2090: };
1.327 ihickson 2091: <a href="#sharedworker">SharedWorker</a> implements <a href="#abstractworker">AbstractWorker</a>;</pre>
2092:
2093: <p>The <dfn id="dom-sharedworker-port" title="dom-SharedWorker-port"><code>port</code></dfn>
1.81 ihickson 2094: attribute must return the value it was assigned by the object's
1.301 ihickson 2095: constructor. It represents the <code><a href="#messageport">MessagePort</a></code> for
1.327 ihickson 2096: communicating with the shared worker.</p>
2097:
2098: <p>When the <dfn id="dom-sharedworker" title="dom-SharedWorker"><code>SharedWorker(<var title="">scriptURL</var>, <var title="">name</var>)</code></dfn>
1.81 ihickson 2099: constructor is invoked, the user agent must run the following
1.327 ihickson 2100: steps:</p>
2101:
2102: <ol><li><p><span title="resolve a url">Resolve</span> the <var title="">scriptURL</var> argument.</li>
1.81 ihickson 2103:
1.309 ihickson 2104: <li><p>If this fails, throw a <code>SyntaxError</code>
1.81 ihickson 2105: exception.</li>
2106:
1.159 ihickson 2107: <li><p>Otherwise, let <var title="">scriptURL</var> be the
2108: resulting <span>absolute URL</span>.</li>
2109:
2110: <li><p>Let <var title="">name</var> be the value of the second
1.164 ihickson 2111: argument, or the empty string if the second argument was
2112: omitted.</li>
1.159 ihickson 2113:
1.167 ihickson 2114: <li>
2115:
1.339 ihickson 2116: <p>If the <span title="url-scheme"><scheme></span> component of
2117: <var title="">scriptURL</var> is not "<code title="data-protocol">data</code>", and the <span>origin</span> of
2118: <var title="">scriptURL</var> is not the <span title="same
2119: origin">same</span> as the origin of the <span>entry
2120: script</span>, then throw a <code>SecurityError</code> exception
2121: and abort these steps.</p>
1.167 ihickson 2122:
1.334 ihickson 2123: <p class="note">Thus, scripts must either be external files with
1.339 ihickson 2124: the same scheme, host, and port as the original page, or <span title="data protocol"><code title="">data:</code> URLs</span>. For
2125: example, you can't load a script from a <span title="javascript
2126: protocol"><code title="">javascript:</code> URL</span>, and an
2127: <code>http:</code> page couldn't start workers using scripts with
2128: <code>http:</code> URLs.</p>
1.167 ihickson 2129:
2130: </li>
1.9 ihickson 2131:
2132: <li>
2133:
1.123 ihickson 2134: <p>Let <var title="">docs</var> be the <a href="#list-of-relevant-document-objects-to-add">list of relevant
1.192 ihickson 2135: <code>Document</code> objects to add</a> given the <span title="script's global object">global object</span> of the <span title="concept-script">script</span> that invoked the
1.123 ihickson 2136: constructor.</p>
2137:
2138: </li>
2139:
2140: <li>
2141:
1.50 ihickson 2142: <p>Execute the following substeps atomically:</p>
1.9 ihickson 2143:
1.155 ihickson 2144: <ol><li><p>Create a new <code><a href="#sharedworker">SharedWorker</a></code> object, which will
1.115 ihickson 2145: shortly be associated with a <code><a href="#sharedworkerglobalscope">SharedWorkerGlobalScope</a></code>
2146: object. Let this <code><a href="#sharedworker">SharedWorker</a></code> object be <var title="">worker</var>.</li>
1.81 ihickson 2147:
1.301 ihickson 2148: <li><p><span>Create a new <code><a href="#messageport">MessagePort</a></code> object</span>
1.192 ihickson 2149: owned by the <span title="script's global object">global
2150: object</span> of the script that invoked the method. Let this be
1.123 ihickson 2151: the <var title="">outside port</var>.</li>
1.81 ihickson 2152:
1.115 ihickson 2153: <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>
1.81 ihickson 2154:
1.164 ihickson 2155: <li><p>Let <var title="">worker global scope</var> be
2156: null.</li>
2157:
1.312 ihickson 2158: <li>
2159:
2160: <p>If <var title="">name</var> is not the empty string and there
2161: exists a <code><a href="#sharedworkerglobalscope">SharedWorkerGlobalScope</a></code> object whose <a href="#dom-workerglobalscope-closing" title="dom-WorkerGlobalScope-closing">closing</a> flag is
2162: false, whose <code title="dom-WorkerGlobalScope-name">name</code> attribute is
1.339 ihickson 2163: exactly equal to <var title="">name</var>, and whose
2164: <a href="#worker-origin">worker origin</a> is the <span>same origin</span> as
2165: <var title="">scriptURL</var>, then let <var title="">worker
2166: global scope</var> be that <code><a href="#sharedworkerglobalscope">SharedWorkerGlobalScope</a></code>
2167: object.</p>
1.312 ihickson 2168:
2169: <p>Otherwise, if <var title="">name</var> is the empty string
2170: and there exists a <code><a href="#sharedworkerglobalscope">SharedWorkerGlobalScope</a></code> object
2171: whose <a href="#dom-workerglobalscope-closing" title="dom-WorkerGlobalScope-closing">closing</a>
2172: flag is false, whose <code title="dom-WorkerGlobalScope-name">name</code> attribute is the
2173: empty string, and whose <code title="dom-WorkerGlobalScope-location"><a href="#dom-workerglobalscope-location">location</a></code> attribute
2174: represents an <span>absolute URL</span> that is exactly equal to
2175: <var title="">scriptURL</var>, then let <var title="">worker
2176: global scope</var> be that <code><a href="#sharedworkerglobalscope">SharedWorkerGlobalScope</a></code>
2177: object.</p>
2178:
2179: </li>
2180:
2181: <li>
2182:
2183: <p>If <var title="">worker global scope</var> is not null, but
2184: the user agent has been configured to disallow communication
2185: between the <span title="concept-script">script</span> that
2186: invoked the constructor and the worker represented by the <var title="">worker global scope</var>, then set <var title="">worker global scope</var> to null.</p>
2187:
2188: <p class="note">For example, a user agent could have a
2189: development mode that isolates a particular <span>top-level
2190: browsing context</span> from all other pages, and scripts in
2191: that development mode could be blocked from connecting to shared
2192: workers running in the normal browser mode.</p>
2193:
2194: </li>
1.164 ihickson 2195:
1.9 ihickson 2196: <li>
2197:
1.164 ihickson 2198: <p>If <var title="">worker global scope</var> is not null, then
2199: run these steps:</p>
1.81 ihickson 2200:
1.164 ihickson 2201: <ol><li><p>If <var title="">worker global scope</var>'s <code title="dom-WorkerGlobalScope-location"><a href="#dom-workerglobalscope-location">location</a></code>
1.81 ihickson 2202: attribute represents an <span>absolute URL</span> that is not
1.159 ihickson 2203: exactly equal to <var title="">scriptURL</var>, then throw a
1.309 ihickson 2204: <code>URLMismatchError</code> exception and abort all these
1.159 ihickson 2205: steps.</li>
1.81 ihickson 2206:
2207: <li><p>Associate <var title="">worker</var> with <var title="">worker global scope</var>.</li>
2208:
1.301 ihickson 2209: <li><p><span>Create a new <code><a href="#messageport">MessagePort</a></code>
1.185 ihickson 2210: object</span> owned by <var title="">worker global
2211: scope</var>. Let this be the <var title="">inside
2212: port</var>.</li>
1.81 ihickson 2213:
2214: <li><p><span>Entangle</span> <var title="">outside port</var>
2215: and <var title="">inside port</var>.</li>
2216:
2217: <li><p>Return <var title="">worker</var> and perform the next
2218: step asynchronously.</li>
1.9 ihickson 2219:
1.344 ihickson 2220: <li><p>Create a <span title="concept-events-trusted">trusted</span> event that uses the
2221: <code>MessageEvent</code> interface, with the name <code title="event-connect">connect</code>, which does not bubble, is not cancelable, has no
2222: default action, has a <code title="dom-MessageEvent-data">data</code> attribute whose value
2223: is initialized to the empty string, has a <code title="dom-MessageEvent-ports">ports</code>
2224: attribute whose value is initialized to a <span title="dfn-read-only-array">read only</span>
2225: array containing only the newly created port, and has a <code title="dom-MessageEvent-source">source</code> attribute whose value is initialized to the
2226: newly created port, and <span>queue a task</span> to dispatch the event at <var title="">worker global scope</var>.</li>
1.43 ihickson 2227:
1.123 ihickson 2228: <li>
2229:
2230: <p><a href="#add-a-document-to-the-worker-s-documents" title="add a document to the worker's documents">Add to
2231: <var title="">worker global scope</var>'s list of <span>the
2232: worker's <code>Document</code>s</span></a> the
2233: <code>Document</code> objects in <var title="">docs</var>.</p>
2234:
2235: </li>
2236:
1.124 ihickson 2237: <li>
2238:
1.192 ihickson 2239: <p>If the <span title="script's global object">global
2240: object</span> of the <span title="concept-script">script</span>
1.124 ihickson 2241: that invoked the constructor is a
2242: <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
2243: worker's workers</a> of the <code><a href="#workerglobalscope">WorkerGlobalScope</a></code>
1.192 ihickson 2244: object that is the <span title="script's global object">global
2245: object</span> of the <span title="concept-script">script</span>
1.124 ihickson 2246: that invoked the constructor.</p>
2247:
2248: </li>
2249:
1.81 ihickson 2250: <li><p>Abort all these steps.</li>
1.9 ihickson 2251:
1.155 ihickson 2252: </ol></li>
1.9 ihickson 2253:
1.339 ihickson 2254: <li><p>Create a new <code><a href="#sharedworkerglobalscope">SharedWorkerGlobalScope</a></code> object
2255: whose <a href="#worker-origin">worker origin</a> is the origin of the <span>entry
2256: script</span>. Let <var title="">worker global scope</var> be
2257: this new object.</li>
1.9 ihickson 2258:
1.81 ihickson 2259: <li><p>Associate <var title="">worker</var> with <var title="">worker global scope</var>.</li>
1.9 ihickson 2260:
1.115 ihickson 2261: <li><p>Set the <code title="dom-SharedWorkerGlobalScope-name"><a href="#dom-sharedworkerglobalscope-name">name</a></code> attribute of
1.81 ihickson 2262: <var title="">worker global scope</var> to <var title="">name</var>.</li>
1.9 ihickson 2263:
1.301 ihickson 2264: <li><p><span>Create a new <code><a href="#messageport">MessagePort</a></code> object</span>
1.81 ihickson 2265: owned by <var title="">worker global scope</var>. Let <var title="">inside port</var> be this new object.</li>
1.9 ihickson 2266:
1.81 ihickson 2267: <li><p><span>Entangle</span> <var title="">outside port</var> and
2268: <var title="">inside port</var>.</li>
1.9 ihickson 2269:
1.155 ihickson 2270: </ol></li>
1.28 ihickson 2271:
1.123 ihickson 2272: <li><p>Return <var title="">worker</var> and perform the remaining
2273: steps asynchronously.</li>
1.18 ihickson 2274:
1.344 ihickson 2275: <li><p>Create a <span title="concept-events-trusted">trusted</span> event that uses the
2276: <code>MessageEvent</code> interface, with the name <code title="event-connect">connect</code>,
2277: which does not bubble, is not cancelable, has no default action, has a <code title="dom-MessageEvent-data">data</code> attribute whose value is initialized to the empty
2278: string, has a <code title="dom-MessageEvent-ports">ports</code> attribute whose value is
2279: initialized to a <span title="dfn-read-only-array">read only</span> array containing only the
2280: newly created port, and has a <code title="dom-MessageEvent-source">source</code> attribute whose
2281: value is initialized to the newly created port, and <span>queue a task</span> to dispatch the
2282: event at <var title="">worker global scope</var>.</li>
1.26 ihickson 2283:
2284: <li>
1.46 ihickson 2285:
1.123 ihickson 2286: <p><a href="#add-a-document-to-the-worker-s-documents" title="add a document to the worker's documents">Add to
2287: <var title="">worker global scope</var>'s list of <span>the
2288: worker's <code>Document</code>s</span></a> the
2289: <code>Document</code> objects in <var title="">docs</var>.</p>
2290:
2291: </li>
2292:
2293: <li>
2294:
1.192 ihickson 2295: <p>If the <span title="script's global object">global object</span>
1.124 ihickson 2296: of the <span title="concept-script">script</span> that invoked the
2297: 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
2298: worker's workers</a> of the <code><a href="#workerglobalscope">WorkerGlobalScope</a></code>
1.192 ihickson 2299: object that is the <span title="script's global object">global
2300: object</span> of the <span title="concept-script">script</span>
1.124 ihickson 2301: that invoked the constructor.</p>
2302:
2303: </li>
2304:
2305: <li>
2306:
1.159 ihickson 2307: <p><a href="#run-a-worker">Run a worker</a> for <var title="">scriptURL</var>,
1.193 ihickson 2308: with the <span>script's browsing context</span> of the script that
1.159 ihickson 2309: invoked the method as the <var title="">owner browsing
1.232 ihickson 2310: context</var>, with the <span>script's document</span> of the
2311: script that invoked the method as the <var title="">owner
2312: document</var>, with the <span>origin</span> of the <span>entry
1.176 ihickson 2313: script</span> as the <var title="">owner origin</var>, and with
2314: <var title="">worker global scope</var> as the global scope.</p>
1.26 ihickson 2315:
1.60 ihickson 2316: </li>
1.81 ihickson 2317:
1.155 ihickson 2318: </ol><p>This constructor must be visible when the <span>script's global
1.192 ihickson 2319: object</span> is either a <code>Window</code> object or an object
1.327 ihickson 2320: implementing the <code><a href="#workerutils">WorkerUtils</a></code> interface.</p>
2321:
2322: <p>The <span>task source</span> for the tasks mentioned above is the
2323: <span>DOM manipulation task source</span>.</p>
2324:
2325:
2326:
2327: <h2 id="apis-available-to-workers"><span class="secno">5 </span>APIs available to workers</h2>
2328:
2329: <pre class="idl">[NoInterfaceObject]
1.150 ihickson 2330: interface <dfn id="workerutils">WorkerUtils</dfn> {
1.306 ihickson 2331: void <a href="#dom-workerglobalscope-importscripts" title="dom-WorkerGlobalScope-importScripts">importScripts</a>(DOMString... urls);
1.210 ihickson 2332: readonly attribute <a href="#workernavigator">WorkerNavigator</a> <a href="#dom-worker-navigator" title="dom-worker-navigator">navigator</a>;
1.150 ihickson 2333: };
1.290 ihickson 2334: <a href="#workerutils">WorkerUtils</a> implements <span>WindowTimers</span>;
1.327 ihickson 2335: <a href="#workerutils">WorkerUtils</a> implements <span>WindowBase64</span>;</pre>
2336:
2337:
2338: <p>The <code>WindowTimers</code> and <code>WindowBase64</code>
2339: interfaces are defined in the HTML specification. <a href="#refsHTML">[HTML]</a></p>
2340:
2341:
2342: <p>The DOM APIs (<code>Node</code> objects, <code>Document</code>
1.81 ihickson 2343: objects, etc) are not available to workers in this version of this
1.327 ihickson 2344: specification.</p>
2345:
2346:
2347: <h3 id="importing-scripts-and-libraries"><span class="secno">5.1 </span>Importing scripts and libraries</h3>
2348:
2349: <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
1.115 ihickson 2350: <code><a href="#workerglobalscope">WorkerGlobalScope</a></code> object, the user agent must run the
1.327 ihickson 2351: following steps:</p>
2352:
2353: <ol><li><p>If there are no arguments, return without doing
1.81 ihickson 2354: anything. Abort these steps.</li>
2355:
2356: <li><p><span title="resolve a url">Resolve</span> each
2357: argument.</li>
2358:
1.309 ihickson 2359: <li><p>If any fail, throw a <code>SyntaxError</code>
1.81 ihickson 2360: exception.</li>
2361:
1.26 ihickson 2362: <li>
1.81 ihickson 2363:
1.341 ihickson 2364: <p>Attempt to <span>fetch</span> each resource
2365: identified by the resulting <span title="absolute URL">absolute
2366: URLs</span>, from the <span>entry script</span>'s
2367: <span>origin</span>, using the <span>entry script</span>'s <span title="script's referrer source">referrer source</span>, and with
2368: the <i>synchronous flag</i> set.</p>
1.318 ihickson 2369:
1.81 ihickson 2370: </li>
1.26 ihickson 2371:
2372: <li>
2373:
1.81 ihickson 2374: <p>For each argument in turn, in the order given, starting with
2375: the first one, run these substeps:</p>
1.26 ihickson 2376:
1.155 ihickson 2377: <ol><li>
1.26 ihickson 2378:
1.81 ihickson 2379: <p>Wait for the fetching attempt for the corresponding resource
2380: to complete.</p>
1.60 ihickson 2381:
1.81 ihickson 2382: <p>If the fetching attempt failed, throw a
1.309 ihickson 2383: <code>NetworkError</code> exception and abort all these
1.81 ihickson 2384: steps.</p>
1.45 ihickson 2385:
1.264 ihickson 2386: <p>If the attempt succeeds, then let <var title="">source</var> be
2387: the script resource <span>decoded as UTF-8, with error
2388: handling</span>.
2389:
2390: <a href="#refsHTML">[HTML]</a>
2391:
2392: </p>
1.85 ihickson 2393:
2394: <p>Let <var title="">language</var> be JavaScript.</p>
1.61 ihickson 2395:
1.115 ihickson 2396: <p class="note">As with the worker's script, the script here is
1.81 ihickson 2397: always assumed to be JavaScript, regardless of the MIME
1.170 ihickson 2398: type.</p>
1.61 ihickson 2399:
1.81 ihickson 2400: </li>
1.26 ihickson 2401:
1.81 ihickson 2402: <li>
1.26 ihickson 2403:
1.314 ihickson 2404: <p><span>Create a script</span>, using <var title="">source</var> as the script source, the <span>URL</span>
2405: from which <var title="">source</var> was obtained, and <var title="">language</var> as the scripting language, using the
1.341 ihickson 2406: same global object, browsing context, document, referrer source,
2407: URL character encoding, and base URL as the <span title="concept-script">script</span> that was created by the
1.115 ihickson 2408: worker's <a href="#run-a-worker">run a worker</a> algorithm.</p>
1.81 ihickson 2409:
1.115 ihickson 2410: <p>Let the newly created <span title="concept-script">script</span> run until it either
1.81 ihickson 2411: returns, fails to parse, fails to catch an exception, or gets
1.115 ihickson 2412: prematurely aborted by the "<a href="#kill-a-worker">kill a worker</a>" or
2413: "<a href="#terminate-a-worker">terminate a worker</a>" algorithms defined above.</p>
1.26 ihickson 2414:
1.199 ihickson 2415: <p>If it failed to parse, then throw an ECMAScript
2416: <code>SyntaxError</code> exception and abort all these
2417: steps. <a href="#refsECMA262">[ECMA262]</a></p>
1.63 ihickson 2418:
1.320 ihickson 2419: <p>If an exception was thrown or if the script was prematurely
1.81 ihickson 2420: aborted, then abort all these steps, letting the exception or
2421: aborting continue to be processed by the script that called the
1.115 ihickson 2422: <code title="dom-WorkerGlobalScope-importScripts"><a href="#dom-workerglobalscope-importscripts">importScripts()</a></code>
1.81 ihickson 2423: method.</p>
2424:
1.115 ihickson 2425: <p>If the "<a href="#kill-a-worker">kill a worker</a>" or "<a href="#terminate-a-worker">terminate a
1.81 ihickson 2426: worker</a>" algorithms abort the script then abort all these
2427: steps.</p>
2428:
2429: </li>
2430:
1.155 ihickson 2431: </ol></li>
1.152 ihickson 2432:
1.327 ihickson 2433: </ol><h3 id="the-workernavigator-object"><span class="secno">5.2 </span>The <code><a href="#workernavigator">WorkerNavigator</a></code> object</h3>
2434:
2435: <p>The <dfn id="dom-worker-navigator" title="dom-worker-navigator"><code>navigator</code></dfn> attribute
1.115 ihickson 2436: of the <code><a href="#workerutils">WorkerUtils</a></code> interface must return an instance of
1.210 ihickson 2437: the <code><a href="#workernavigator">WorkerNavigator</a></code> interface, which represents the
1.327 ihickson 2438: identity and state of the user agent (the client):</p>
2439:
2440: <pre class="idl">interface <dfn id="workernavigator">WorkerNavigator</dfn> {};
1.210 ihickson 2441: <a href="#workernavigator">WorkerNavigator</a> implements <span>NavigatorID</span>;
1.327 ihickson 2442: <a href="#workernavigator">WorkerNavigator</a> implements <span>NavigatorOnLine</span>;</pre>
2443:
2444: <p>Objects implementing the <code><a href="#workernavigator">WorkerNavigator</a></code> interface
1.210 ihickson 2445: also implement the <code>NavigatorID</code> and
2446: <code>NavigatorOnLine</code> interfaces.
1.205 ihickson 2447:
1.226 ihickson 2448: <a href="#refsHTML">[HTML]</a>
1.205 ihickson 2449:
1.327 ihickson 2450: </p>
2451:
1.338 ihickson 2452: <p>The <code><a href="#workernavigator">WorkerNavigator</a></code> interface must only be <span title="expose">exposed</span> if the <span>JavaScript global
2453: environment</span> is a <span>worker environment</span>.</p>
1.327 ihickson 2454:
2455:
2456:
2457:
2458: <h3 id="interface-objects-and-constructors"><span class="secno">5.3 </span>Interface objects and constructors</h3>
2459:
1.338 ihickson 2460: <p>Nothing must be <span title="expose">exposed</span> when the
2461: <span>JavaScript global environment</span> is a <span>worker
2462: environment</span> except for the following:</p>
1.327 ihickson 2463:
2464: <ul><li><p><code>XMLHttpRequest</code> and all interface objects and
1.81 ihickson 2465: constructors defined by the XMLHttpRequest specifications, except
2466: that the <span>document response entity body</span> must always be
1.160 ihickson 2467: null. The <span><code>XMLHttpRequest</code> base URL</span> is the
2468: <span>script's base URL</span>; the
2469: <span><code>XMLHttpRequest</code> origin</span> is the script's
1.341 ihickson 2470: <span>origin</span>, and the <span><code>XMLHttpRequest</code>
2471: referrer source</span> is the <span>script's referrer
2472: source</span>. <a href="#refsXHR">[XHR]</a></li>
1.81 ihickson 2473:
1.205 ihickson 2474: <li><p>The interface objects and constructors defined by this
1.338 ihickson 2475: specification, except where is further restricted by explicit
2476: requirements in this specification.</li>
1.119 ihickson 2477:
1.338 ihickson 2478: <li><p>The interface objects of any objects made accessible through
2479: interfaces implemented by any objects that are themselves <span title="expose">exposed</span> (i.e. this requirement is
2480: transitive).</li>
1.205 ihickson 2481:
2482: </ul><p class="note">These requirements do not override the requirements
2483: defined by the Web IDL specification, in particular concerning the
1.327 ihickson 2484: visibility of interfaces annotated with the <code title="">[NoInterfaceObject]</code> extended attribute.</p>
2485:
2486:
2487: <h3 id="worker-locations"><span class="secno">5.4 </span>Worker locations</h3>
2488:
2489: <pre class="idl">interface <dfn id="workerlocation">WorkerLocation</dfn> {
1.263 ihickson 2490: // <span>URL decomposition IDL attributes</span>
1.294 ihickson 2491: stringifier readonly attribute DOMString <a href="#dom-workerlocation-href" title="dom-WorkerLocation-href">href</a>;
1.115 ihickson 2492: readonly attribute DOMString <a href="#dom-workerlocation-protocol" title="dom-WorkerLocation-protocol">protocol</a>;
2493: readonly attribute DOMString <a href="#dom-workerlocation-host" title="dom-WorkerLocation-host">host</a>;
2494: readonly attribute DOMString <a href="#dom-workerlocation-hostname" title="dom-WorkerLocation-hostname">hostname</a>;
2495: readonly attribute DOMString <a href="#dom-workerlocation-port" title="dom-WorkerLocation-port">port</a>;
2496: readonly attribute DOMString <a href="#dom-workerlocation-pathname" title="dom-WorkerLocation-pathname">pathname</a>;
2497: readonly attribute DOMString <a href="#dom-workerlocation-search" title="dom-WorkerLocation-search">search</a>;
2498: readonly attribute DOMString <a href="#dom-workerlocation-hash" title="dom-WorkerLocation-hash">hash</a>;
1.327 ihickson 2499: };</pre>
2500:
2501: <p>A <code><a href="#workerlocation">WorkerLocation</a></code> object represents an <span>absolute
2502: URL</span> set at its creation.</p>
2503:
2504: <p>The <dfn id="dom-workerlocation-href" title="dom-WorkerLocation-href"><code>href</code></dfn>
1.81 ihickson 2505: attribute must return the <span>absolute URL</span> that the object
1.327 ihickson 2506: represents.</p>
2507:
2508: <p>The <code><a href="#workerlocation">WorkerLocation</a></code> interface also has the complement
1.163 ihickson 2509: of <span>URL decomposition IDL attributes</span>, <dfn id="dom-workerlocation-protocol" title="dom-WorkerLocation-protocol"><code>protocol</code></dfn>,
1.115 ihickson 2510: <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>,
2511: <dfn id="dom-workerlocation-pathname" title="dom-WorkerLocation-pathname"><code>pathname</code></dfn>,
2512: <dfn id="dom-workerlocation-search" title="dom-WorkerLocation-search"><code>search</code></dfn>,
1.263 ihickson 2513: and <dfn id="dom-workerlocation-hash" title="dom-WorkerLocation-hash"><code>hash</code></dfn>.
2514: These must follow the rules given for <span>URL decomposition IDL
2515: attributes</span>, with the <span title="concept-uda-input">input</span> being the <span>absolute
2516: URL</span> that the object represents (same as the <code title="dom-WorkerLocation-href"><a href="#dom-workerlocation-href">href</a></code> attribute), and the
2517: <span title="concept-uda-setter">common setter action</span> being a
2518: no-op, since the attributes are defined to be readonly.
1.205 ihickson 2519:
1.226 ihickson 2520: <a href="#refsHTML">[HTML]</a>
1.205 ihickson 2521:
1.327 ihickson 2522: </p>
2523:
1.338 ihickson 2524: <p>The <code><a href="#workerlocation">WorkerLocation</a></code> interface must only be <span title="expose">exposed</span> if the <span>JavaScript global
2525: environment</span> is a <span>worker environment</span>.</p>
1.327 ihickson 2526:
2527:
2528:
2529:
2530:
2531:
2532: <h2 class="no-num" id="references">References</h2>
2533:
2534: <p>All references are normative unless marked "Non-normative".</p>
2535:
2536:
2537:
2538: <dl><dt id="refsDOMCORE">[DOMCORE]</dt>
1.342 ihickson 2539: <dd><cite><a href="http://dom.spec.whatwg.org/">Web DOM Core</a></cite>, A. van Kesteren. WHATWG.</dd>
1.153 ihickson 2540:
1.152 ihickson 2541: <dt id="refsECMA262">[ECMA262]</dt>
1.335 ihickson 2542: <dd><cite><a href="http://www.ecma-international.org/publications/standards/Ecma-262.htm">ECMAScript Language Specification</a></cite>. ECMA.</dd>
1.152 ihickson 2543:
1.226 ihickson 2544: <dt id="refsHTML">[HTML]</dt>
1.346 ! ihickson 2545: <dd><cite><a href="http://www.whatwg.org/specs/web-apps/current-work/">HTML</a></cite>, I. Hickson. WHATWG.</dd>
1.315 ihickson 2546:
1.154 ihickson 2547: <dt id="refsRFC2119">[RFC2119]</dt>
1.265 ihickson 2548: <dd><cite><a href="http://tools.ietf.org/html/rfc2119">Key words for use in
1.226 ihickson 2549: RFCs to Indicate Requirement Levels</a></cite>, S. Bradner. IETF.</dd>
1.154 ihickson 2550:
2551: <dt id="refsWEBIDL">[WEBIDL]</dt>
1.318 ihickson 2552:
2553: <dd><cite><a href="http://dev.w3.org/2006/webapi/WebIDL/">Web
1.226 ihickson 2554: IDL</a></cite>, C. McCormack. W3C.</dd>
1.154 ihickson 2555:
1.152 ihickson 2556: <dt id="refsXHR">[XHR]</dt>
1.342 ihickson 2557: <dd><cite><a href="http://xhr.spec.whatwg.org/"><code>XMLHttpRequest</code></a></cite>, A. van Kesteren. WHATWG.</dd>
1.152 ihickson 2558:
1.327 ihickson 2559: </dl><h2 class="no-num" id="acknowledgements">Acknowledgements</h2> <!-- ACKS -->
2560:
2561: <p>Thanks to
1.81 ihickson 2562:
2563: Aaron Boodman,
1.155 ihickson 2564: Алексей Проскуряков (Alexey Proskuryakov),
1.81 ihickson 2565: Anne van Kesteren,
2566: Ben Turner,
2567: Dmitry Titov,
1.96 ihickson 2568: Drew Wilson,
1.97 ihickson 2569: Jeremy Orlow,
1.81 ihickson 2570: Jonas Sicking,
2571: Justin James,
2572: Kevin Hakanson,
2573: Maciej Stachowiak,
2574: Michael Nordman,
2575: Mike Smith,
2576:
2577: and
2578:
2579: Philip Taylor
2580:
1.327 ihickson 2581: for their useful and substantial comments.</p>
2582:
2583: <p>Huge thanks to the whole Gears team, who pioneered this
1.81 ihickson 2584: technology and whose experience has been a huge influence on this
1.327 ihickson 2585: specification.</p>
2586:
2587:
Webmaster
![[BACK]](/http/77726476706e69737468656265737421f4f257d23063265f6c0f/cvsweb/icons/back.gif?vpn-1){kind=icon}
Return to Overview.html CVS log ![[TXT]](/http/77726476706e69737468656265737421f4f257d23063265f6c0f/cvsweb/icons/text.gif?vpn-1){kind=icon}
![[DIR]](/http/77726476706e69737468656265737421f4f257d23063265f6c0f/cvsweb/icons/dir.gif?vpn-1){kind=icon}
Up to [Public] / html5 / workers