Rename ActiveDOMObject::canSuspend() to canSuspendForPageCache() for clarity
[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 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 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 #include "AbstractWorker.h"
31 #include "ActiveDOMObject.h"
32 #include "EventListener.h"
33 #include "EventTarget.h"
34 #include "MessagePort.h"
35 #include "WorkerScriptLoaderClient.h"
36 #include <wtf/Forward.h>
37 #include <wtf/PassRefPtr.h>
38 #include <wtf/RefPtr.h>
39 #include <wtf/text/AtomicStringHash.h>
40
41 namespace WebCore {
42
43     class ScriptExecutionContext;
44     class WorkerGlobalScopeProxy;
45     class WorkerScriptLoader;
46
47     typedef int ExceptionCode;
48
49     class Worker final : public AbstractWorker, public ActiveDOMObject, private WorkerScriptLoaderClient {
50     public:
51         static PassRefPtr<Worker> create(ScriptExecutionContext&, const String& url, ExceptionCode&);
52         virtual ~Worker();
53
54         virtual EventTargetInterface eventTargetInterface() const override { return WorkerEventTargetInterfaceType; }
55
56         void postMessage(PassRefPtr<SerializedScriptValue> message, const MessagePortArray*, ExceptionCode&);
57         // Needed for Objective-C bindings (see bug 28774).
58         void postMessage(PassRefPtr<SerializedScriptValue> message, MessagePort*, ExceptionCode&);
59
60         void terminate();
61
62         // EventTarget API.
63         virtual ScriptExecutionContext* scriptExecutionContext() const override final { return ActiveDOMObject::scriptExecutionContext(); }
64
65         // ActiveDOMObject API.
66         bool hasPendingActivity() const override;
67
68     private:
69         explicit Worker(ScriptExecutionContext&);
70
71         void notifyNetworkStateChange(bool isOnline);
72
73         // WorkerScriptLoaderClient callbacks
74         virtual void didReceiveResponse(unsigned long identifier, const ResourceResponse&) override;
75         virtual void notifyFinished() override;
76
77         // ActiveDOMObject API.
78         bool canSuspendForPageCache() const override;
79         void stop() override;
80         const char* activeDOMObjectName() const override;
81
82         friend void networkStateChanged(bool isOnLine);
83
84         RefPtr<WorkerScriptLoader> m_scriptLoader;
85         WorkerGlobalScopeProxy* m_contextProxy; // The proxy outlives the worker to perform thread shutdown.
86     };
87
88 } // namespace WebCore
89
90 #endif // Worker_h