Tighten AbstractWorker and subclasses a bit.
[WebKit.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/PassRefPtr.h>
41 #include <wtf/RefPtr.h>
42 #include <wtf/text/AtomicStringHash.h>
43
44 namespace WebCore {
45
46     class ScriptExecutionContext;
47     class WorkerGlobalScopeProxy;
48     class WorkerScriptLoader;
49
50     typedef int ExceptionCode;
51
52     class Worker final : public AbstractWorker, private WorkerScriptLoaderClient {
53     public:
54         static PassRefPtr<Worker> create(ScriptExecutionContext&, const String& url, ExceptionCode&);
55         virtual ~Worker();
56
57         virtual EventTargetInterface eventTargetInterface() const override { return WorkerEventTargetInterfaceType; }
58
59         void postMessage(PassRefPtr<SerializedScriptValue> message, const MessagePortArray*, ExceptionCode&);
60         // Needed for Objective-C bindings (see bug 28774).
61         void postMessage(PassRefPtr<SerializedScriptValue> message, MessagePort*, ExceptionCode&);
62
63         void terminate();
64
65         virtual bool canSuspend() const override;
66         virtual void stop() override;
67         virtual bool hasPendingActivity() const override;
68     
69         DEFINE_ATTRIBUTE_EVENT_LISTENER(message);
70
71     private:
72         explicit Worker(ScriptExecutionContext&);
73
74         void notifyNetworkStateChange(bool isOnline);
75
76         // WorkerScriptLoaderClient callbacks
77         virtual void didReceiveResponse(unsigned long identifier, const ResourceResponse&) override;
78         virtual void notifyFinished() override;
79
80         friend void networkStateChanged(bool isOnLine);
81
82         RefPtr<WorkerScriptLoader> m_scriptLoader;
83         WorkerGlobalScopeProxy* 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