0e673ac28582bb52918e811bb0256d1578766838
[WebKit-https.git] / Source / WebCore / workers / Worker.h
1 /*
2  * Copyright (C) 2008, 2010 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 #ifndef Worker_h
28 #define Worker_h
29
30 #if ENABLE(WORKERS)
31
32 #include "AbstractWorker.h"
33 #include "ActiveDOMObject.h"
34 #include "EventListener.h"
35 #include "EventNames.h"
36 #include "EventTarget.h"
37 #include "MessagePort.h"
38 #include "WorkerScriptLoaderClient.h"
39 #include <wtf/Forward.h>
40 #include <wtf/OwnPtr.h>
41 #include <wtf/PassRefPtr.h>
42 #include <wtf/RefCounted.h>
43 #include <wtf/RefPtr.h>
44 #include <wtf/text/AtomicStringHash.h>
45
46 namespace WebCore {
47
48     class ScriptExecutionContext;
49     class WorkerContextProxy;
50     class WorkerScriptLoader;
51
52     typedef int ExceptionCode;
53
54     class Worker : public AbstractWorker, private WorkerScriptLoaderClient {
55     public:
56         static PassRefPtr<Worker> create(const String& url, ScriptExecutionContext*, ExceptionCode&);
57         virtual ~Worker();
58
59         virtual Worker* toWorker() { return this; }
60
61         void postMessage(PassRefPtr<SerializedScriptValue> message, ExceptionCode&);
62         void postMessage(PassRefPtr<SerializedScriptValue> message, const MessagePortArray*, ExceptionCode&);
63         // FIXME: remove this when we update the ObjC bindings (bug #28774).
64         void postMessage(PassRefPtr<SerializedScriptValue> message, MessagePort*, ExceptionCode&);
65
66         void terminate();
67
68         virtual bool canSuspend() const;
69         virtual void stop();
70         virtual bool hasPendingActivity() const;
71     
72         DEFINE_ATTRIBUTE_EVENT_LISTENER(message);
73
74     private:
75         Worker(ScriptExecutionContext*);
76
77         virtual void notifyFinished();
78
79         virtual void refEventTarget() { ref(); }
80         virtual void derefEventTarget() { deref(); }
81
82         OwnPtr<WorkerScriptLoader> m_scriptLoader;
83         WorkerContextProxy* m_contextProxy; // The proxy outlives the worker to perform thread shutdown.
84     };
85
86 } // namespace WebCore
87
88 #endif // ENABLE(WORKERS)
89
90 #endif // Worker_h