c30d459fe73cf96e5d2f046d333c926e87c61884
[WebKit-https.git] / Source / WebCore / workers / service / server / SWServerWorker.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 "ServiceWorkerData.h"
31 #include "ServiceWorkerIdentifier.h"
32 #include "ServiceWorkerRegistrationKey.h"
33 #include "ServiceWorkerTypes.h"
34 #include "URL.h"
35 #include <wtf/ThreadSafeRefCounted.h>
36
37 namespace WebCore {
38
39 class SWServer;
40 class SWServerRegistration;
41 enum class WorkerType;
42 struct ServiceWorkerJobDataIdentifier;
43
44 class SWServerWorker : public ThreadSafeRefCounted<SWServerWorker> {
45 public:
46     template <typename... Args> static Ref<SWServerWorker> create(Args&&... args)
47     {
48         return adoptRef(*new SWServerWorker(std::forward<Args>(args)...));
49     }
50     
51     SWServerWorker(const SWServerWorker&) = delete;
52     WEBCORE_EXPORT ~SWServerWorker();
53
54     void terminate();
55
56     SWServer& server();
57     const ServiceWorkerRegistrationKey& registrationKey() const { return m_registrationKey; }
58     const URL& scriptURL() const { return m_data.scriptURL; }
59     const String& script() const { return m_script; }
60     WorkerType type() const { return m_data.type; }
61
62     ServiceWorkerIdentifier identifier() const { return m_data.identifier; }
63     SWServerToContextConnectionIdentifier contextConnectionIdentifier() const { return m_contextConnectionIdentifier; }
64
65     ServiceWorkerState state() const { return m_data.state; }
66     void setState(ServiceWorkerState state) { m_data.state = state; }
67
68     bool hasPendingEvents() const { return m_hasPendingEvents; }
69     void setHasPendingEvents(bool value) { m_hasPendingEvents = value; }
70
71     void scriptContextFailedToStart(const std::optional<ServiceWorkerJobDataIdentifier>&, const String& message);
72     void scriptContextStarted(const std::optional<ServiceWorkerJobDataIdentifier>&);
73     void didFinishInstall(const std::optional<ServiceWorkerJobDataIdentifier>&, bool wasSuccessful);
74     void didFinishActivation();
75     void contextTerminated();
76
77     WEBCORE_EXPORT static SWServerWorker* existingWorkerForIdentifier(ServiceWorkerIdentifier);
78
79     const ServiceWorkerData& data() const { return m_data; }
80
81 private:
82     SWServerWorker(SWServer&, SWServerRegistration&, SWServerToContextConnectionIdentifier, const URL&, const String& script, WorkerType, ServiceWorkerIdentifier);
83
84     SWServer& m_server;
85     ServiceWorkerRegistrationKey m_registrationKey;
86     SWServerToContextConnectionIdentifier m_contextConnectionIdentifier;
87     ServiceWorkerData m_data;
88     String m_script;
89     bool m_hasPendingEvents { false };
90 };
91
92 } // namespace WebCore
93
94 #endif // ENABLE(SERVICE_WORKER)