709410a2673676956e0c0b3076c539f0cb5596e1
[WebKit-https.git] / WebCore / workers / WorkerContext.idl
1 /*
2  * Copyright (C) 2008 Apple Inc. All Rights Reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  *
25  */
26
27 module threads {
28
29     interface [
30         Conditional=WORKERS,
31         DelegatingGetOwnPropertySlot,
32         CustomMarkFunction,
33         ExtendsDOMGlobalObject,
34         LegacyParent=JSWorkerContextBase,
35         NoStaticTables
36     ] WorkerContext {
37
38         // WorkerGlobalScope
39 #if defined(LANGUAGE_JAVASCRIPT) && LANGUAGE_JAVASCRIPT
40                  attribute [Replaceable] WorkerContext self;
41 #endif
42                  attribute [Replaceable] WorkerLocation location;
43         void close();
44         //         attribute EventListener onerror;
45
46         // WorkerUtils
47         [Custom] void importScripts(/*[Variadic] in DOMString urls */);
48                  attribute [Replaceable] WorkerNavigator navigator;
49         // Database openDatabase(in DOMString name, in DOMString version, in DOMString displayName, in unsigned long estimatedSize);
50         // DatabaseSync openDatabaseSync(in DOMString name, in DOMString version, in DOMString displayName, in unsigned long estimatedSize);
51
52
53         // DedicatedWorkerGlobalScope
54         void postMessage(in DOMString message, in [Optional] MessagePort messagePort)
55             raises(DOMException);
56                  attribute EventListener onmessage;
57
58         // Timers
59         [Custom] long setTimeout(in TimeoutHandler handler, in long timeout);
60         // [Custom] long setTimeout(in DOMString code, in long timeout);
61         void clearTimeout(in long handle);
62         [Custom] long setInterval(in TimeoutHandler handler, in long timeout);
63         // [Custom] long setInterval(in DOMString code, in long timeout);
64         void clearInterval(in long handle);
65
66
67         // EventTarget interface
68         [Custom] void addEventListener(in DOMString type, 
69                                        in EventListener listener, 
70                                        in boolean useCapture);
71         [Custom] void removeEventListener(in DOMString type, 
72                                           in EventListener listener, 
73                                           in boolean useCapture);
74         boolean dispatchEvent(in Event evt)
75             raises(EventException);
76
77
78         // Constructors
79         attribute MessageEventConstructor MessageEvent;
80         attribute WorkerLocationConstructor WorkerLocation;
81
82 #if ENABLE_CHANNEL_MESSAGING
83         attribute [JSCCustomGetter] MessageChannelConstructor MessageChannel;
84 #endif
85         attribute [JSCCustomGetter] XMLHttpRequestConstructor XMLHttpRequest;
86     };
87
88 }