summaryrefslogtreecommitdiffstats
path: root/dom/serviceworkers/ServiceWorker.h
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 14:29:10 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 14:29:10 +0000
commit2aa4a82499d4becd2284cdb482213d541b8804dd (patch)
treeb80bf8bf13c3766139fbacc530efd0dd9d54394c /dom/serviceworkers/ServiceWorker.h
parentInitial commit. (diff)
downloadfirefox-upstream.tar.xz
firefox-upstream.zip
Adding upstream version 86.0.1.upstream/86.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--dom/serviceworkers/ServiceWorker.h123
1 files changed, 123 insertions, 0 deletions
diff --git a/dom/serviceworkers/ServiceWorker.h b/dom/serviceworkers/ServiceWorker.h
new file mode 100644
index 0000000000..b407865753
--- /dev/null
+++ b/dom/serviceworkers/ServiceWorker.h
@@ -0,0 +1,123 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set ts=8 sts=2 et sw=2 tw=80: */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef mozilla_dom_serviceworker_h__
+#define mozilla_dom_serviceworker_h__
+
+#include "mozilla/DOMEventTargetHelper.h"
+#include "mozilla/dom/BindingDeclarations.h"
+#include "mozilla/dom/ServiceWorkerDescriptor.h"
+#include "mozilla/dom/ServiceWorkerUtils.h"
+
+#ifdef XP_WIN
+# undef PostMessage
+#endif
+
+class nsIGlobalObject;
+
+namespace mozilla {
+namespace dom {
+
+struct PostMessageOptions;
+class ServiceWorkerCloneData;
+
+#define NS_DOM_SERVICEWORKER_IID \
+ { \
+ 0xd42e0611, 0x3647, 0x4319, { \
+ 0xae, 0x05, 0x19, 0x89, 0x59, 0xba, 0x99, 0x5e \
+ } \
+ }
+
+bool ServiceWorkerVisible(JSContext* aCx, JSObject* aObj);
+
+class ServiceWorker final : public DOMEventTargetHelper {
+ public:
+ // Abstract interface for the internal representation of the
+ // ServiceWorker object.
+ class Inner {
+ public:
+ // This will be called when a DOM ServiceWorker object is
+ // created and takes a strong ref to the Inner object.
+ // RemoveServiceWorker() is guaranteed to be called on the
+ // current thread before the ServiceWorker is destroyed.
+ //
+ // In addition, the Inner object should check to see if
+ // the ServiceWorker's state is correct. If not, it should
+ // be updated automatically by calling SetState(). This is
+ // necessary to handle race conditions where the DOM
+ // ServiceWorker object is created while the state is being
+ // updated in another process.
+ virtual void AddServiceWorker(ServiceWorker* aWorker) = 0;
+
+ // This is called when the DOM ServiceWorker object is
+ // destroyed and drops its ref to the Inner object.
+ virtual void RemoveServiceWorker(ServiceWorker* aWorker) = 0;
+
+ // Get the associated registration for this ServiceWorker. The success
+ // callback should always be called asynchronously.
+ virtual void GetRegistration(ServiceWorkerRegistrationCallback&& aSuccessCB,
+ ServiceWorkerFailureCallback&& aFailureCB) = 0;
+
+ virtual void PostMessage(RefPtr<ServiceWorkerCloneData>&& aData,
+ const ClientInfo& aClientInfo,
+ const ClientState& aClientState) = 0;
+
+ NS_INLINE_DECL_PURE_VIRTUAL_REFCOUNTING
+ };
+
+ NS_DECLARE_STATIC_IID_ACCESSOR(NS_DOM_SERVICEWORKER_IID)
+ NS_DECL_ISUPPORTS_INHERITED
+ NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(ServiceWorker, DOMEventTargetHelper)
+
+ IMPL_EVENT_HANDLER(statechange)
+ IMPL_EVENT_HANDLER(error)
+
+ static already_AddRefed<ServiceWorker> Create(
+ nsIGlobalObject* aOwner, const ServiceWorkerDescriptor& aDescriptor);
+
+ virtual JSObject* WrapObject(JSContext* aCx,
+ JS::Handle<JSObject*> aGivenProto) override;
+
+ ServiceWorkerState State() const;
+
+ void SetState(ServiceWorkerState aState);
+
+ void MaybeDispatchStateChangeEvent();
+
+ void GetScriptURL(nsString& aURL) const;
+
+ void PostMessage(JSContext* aCx, JS::Handle<JS::Value> aMessage,
+ const Sequence<JSObject*>& aTransferable, ErrorResult& aRv);
+
+ void PostMessage(JSContext* aCx, JS::Handle<JS::Value> aMessage,
+ const PostMessageOptions& aOptions, ErrorResult& aRv);
+
+ const ServiceWorkerDescriptor& Descriptor() const;
+
+ void DisconnectFromOwner() override;
+
+ private:
+ ServiceWorker(nsIGlobalObject* aWindow,
+ const ServiceWorkerDescriptor& aDescriptor, Inner* aInner);
+
+ // This class is reference-counted and will be destroyed from Release().
+ ~ServiceWorker();
+
+ void MaybeAttachToRegistration(ServiceWorkerRegistration* aRegistration);
+
+ ServiceWorkerDescriptor mDescriptor;
+
+ RefPtr<Inner> mInner;
+ RefPtr<ServiceWorkerRegistration> mRegistration;
+ ServiceWorkerState mLastNotifiedState;
+};
+
+NS_DEFINE_STATIC_IID_ACCESSOR(ServiceWorker, NS_DOM_SERVICEWORKER_IID)
+
+} // namespace dom
+} // namespace mozilla
+
+#endif // mozilla_dom_serviceworker_h__