6f102bc525b70d0534e7f710a44f2599836aa9b1
[WebKit-https.git] / Source / WebCore / workers / service / server / SWServerToContextConnection.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 "SecurityOrigin.h"
31 #include "ServiceWorkerClientQueryOptions.h"
32 #include "ServiceWorkerIdentifier.h"
33 #include "ServiceWorkerTypes.h"
34 #include <wtf/RefCounted.h>
35
36 namespace PAL {
37 class SessionID;
38 }
39
40 namespace WebCore {
41
42 class SWServer;
43 struct ServiceWorkerClientData;
44 struct ServiceWorkerClientIdentifier;
45 struct ServiceWorkerContextData;
46 struct ServiceWorkerJobDataIdentifier;
47
48 class SWServerToContextConnection : public RefCounted<SWServerToContextConnection> {
49 public:
50     WEBCORE_EXPORT virtual ~SWServerToContextConnection();
51
52     SWServerToContextConnectionIdentifier identifier() const { return m_identifier; }
53
54     // Messages to the SW host process
55     virtual void installServiceWorkerContext(const ServiceWorkerContextData&, PAL::SessionID) = 0;
56     virtual void fireInstallEvent(ServiceWorkerIdentifier) = 0;
57     virtual void fireActivateEvent(ServiceWorkerIdentifier) = 0;
58     virtual void terminateWorker(ServiceWorkerIdentifier) = 0;
59     virtual void syncTerminateWorker(ServiceWorkerIdentifier) = 0;
60     virtual void findClientByIdentifierCompleted(uint64_t requestIdentifier, const std::optional<ServiceWorkerClientData>&, bool hasSecurityError) = 0;
61     virtual void matchAllCompleted(uint64_t requestIdentifier, const Vector<ServiceWorkerClientData>&) = 0;
62     virtual void claimCompleted(uint64_t requestIdentifier) = 0;
63     virtual void didFinishSkipWaiting(uint64_t callbackID) = 0;
64
65     // Messages back from the SW host process
66     WEBCORE_EXPORT void scriptContextFailedToStart(const std::optional<ServiceWorkerJobDataIdentifier>&, ServiceWorkerIdentifier, const String& message);
67     WEBCORE_EXPORT void scriptContextStarted(const std::optional<ServiceWorkerJobDataIdentifier>&, ServiceWorkerIdentifier);
68     WEBCORE_EXPORT void didFinishInstall(const std::optional<ServiceWorkerJobDataIdentifier>&, ServiceWorkerIdentifier, bool wasSuccessful);
69     WEBCORE_EXPORT void didFinishActivation(ServiceWorkerIdentifier);
70     WEBCORE_EXPORT void setServiceWorkerHasPendingEvents(ServiceWorkerIdentifier, bool hasPendingEvents);
71     WEBCORE_EXPORT void skipWaiting(ServiceWorkerIdentifier, uint64_t callbackID);
72     WEBCORE_EXPORT void workerTerminated(ServiceWorkerIdentifier);
73     WEBCORE_EXPORT void findClientByIdentifier(uint64_t clientIdRequestIdentifier, ServiceWorkerIdentifier, ServiceWorkerClientIdentifier);
74     WEBCORE_EXPORT void matchAll(uint64_t requestIdentifier, ServiceWorkerIdentifier, const ServiceWorkerClientQueryOptions&);
75     WEBCORE_EXPORT void claim(uint64_t requestIdentifier, ServiceWorkerIdentifier);
76
77     static SWServerToContextConnection* connectionForOrigin(const SecurityOrigin&);
78
79     SecurityOrigin& origin() { return m_origin.get(); }
80
81     virtual void connectionMayNoLongerBeNeeded() = 0;
82
83 protected:
84     WEBCORE_EXPORT explicit SWServerToContextConnection(Ref<SecurityOrigin>&&);
85
86 private:
87     SWServerToContextConnectionIdentifier m_identifier;
88     Ref<SecurityOrigin> m_origin;
89 };
90
91 } // namespace WebCore
92
93 #endif // ENABLE(SERVICE_WORKER)