Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebCore / workers / service / ServiceWorker.h
1 /*
2  * Copyright (C) 2017 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(SERVICE_WORKER)
29
30 #include "ActiveDOMObject.h"
31 #include "ContextDestructionObserver.h"
32 #include "EventTarget.h"
33 #include "ServiceWorkerData.h"
34 #include <JavaScriptCore/Strong.h>
35 #include <wtf/RefCounted.h>
36 #include <wtf/URL.h>
37
38 namespace JSC {
39 class JSValue;
40 }
41
42 namespace WebCore {
43
44 class Frame;
45
46 class ServiceWorker final : public RefCounted<ServiceWorker>, public EventTargetWithInlineData, public ActiveDOMObject {
47 public:
48     using State = ServiceWorkerState;
49     static Ref<ServiceWorker> getOrCreate(ScriptExecutionContext&, ServiceWorkerData&&);
50
51     virtual ~ServiceWorker();
52
53     const URL& scriptURL() const { return m_data.scriptURL; }
54
55     State state() const { return m_data.state; }
56     
57     void scheduleTaskToUpdateState(State);
58
59     ExceptionOr<void> postMessage(ScriptExecutionContext&, JSC::JSValue message, Vector<JSC::Strong<JSC::JSObject>>&&);
60
61     ServiceWorkerIdentifier identifier() const { return m_data.identifier; }
62     ServiceWorkerRegistrationIdentifier registrationIdentifier() const { return m_data.registrationIdentifier; }
63
64     using RefCounted::ref;
65     using RefCounted::deref;
66
67 private:
68     ServiceWorker(ScriptExecutionContext&, ServiceWorkerData&&);
69     void updatePendingActivityForEventDispatch();
70
71     EventTargetInterface eventTargetInterface() const final;
72     ScriptExecutionContext* scriptExecutionContext() const final;
73     void refEventTarget() final { ref(); }
74     void derefEventTarget() final { deref(); }
75
76     // ActiveDOMObject.
77     const char* activeDOMObjectName() const final;
78     bool canSuspendForDocumentSuspension() const final;
79     void stop() final;
80
81     bool isAlwaysOnLoggingAllowed() const;
82
83     ServiceWorkerData m_data;
84     bool m_isStopped { false };
85     RefPtr<PendingActivity<ServiceWorker>> m_pendingActivityForEventDispatch;
86 };
87
88 } // namespace WebCore
89
90 #endif // ENABLE(SERVICE_WORKER)