dom/workers/DataStore.h

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 #ifndef mozilla_dom_workers_DataStore_h
   6 #define mozilla_dom_workers_DataStore_h
   7
   8 #include "mozilla/DOMEventTargetHelper.h"
   9 #include "nsProxyRelease.h"
  10
  11 #include "WorkerFeature.h"
  12
  13 namespace mozilla {
  14
  15 class ErrorResult;
  16
  17 namespace dom {
  18
  19 class Promise;
  20 class DataStore;
  21 class DataStoreImpl;
  22 class StringOrUnsignedLong;
  23 class OwningStringOrUnsignedLong;
  24
  25 namespace workers {
  26
  27 class DataStoreChangeEventProxy;
  28 class WorkerDataStoreCursor;
  29 class WorkerGlobalScope;
  30
  31 class WorkerDataStore MOZ_FINAL : public DOMEventTargetHelper
  32 {
  33 public:
  34   NS_DECL_ISUPPORTS_INHERITED
  35
  36   WorkerDataStore(WorkerGlobalScope* aScope);
  37
  38   // WebIDL (internal functions)
  39
  40   static already_AddRefed<WorkerDataStore> Constructor(GlobalObject& aGlobal,
  41                                                        ErrorResult& aRv);
  42
  43   virtual JSObject* WrapObject(JSContext *aCx) MOZ_OVERRIDE;
  44
  45   // WebIDL (public APIs)
  46
  47   void GetName(JSContext* aCx, nsAString& aName, ErrorResult& aRv);
  48
  49   void GetOwner(JSContext* aCx, nsAString& aOwner, ErrorResult& aRv);
  50
  51   bool GetReadOnly(JSContext* aCx, ErrorResult& aRv);
  52
  53   already_AddRefed<Promise> Get(JSContext* aCx,
  54                                 const Sequence<OwningStringOrUnsignedLong>& aId,
  55                                 ErrorResult& aRv);
  56
  57   already_AddRefed<Promise> Put(JSContext* aCx,
  58                                 JS::Handle<JS::Value> aObj,
  59                                 const StringOrUnsignedLong& aId,
  60                                 const nsAString& aRevisionId,
  61                                 ErrorResult& aRv);
  62
  63   already_AddRefed<Promise> Add(JSContext* aCx,
  64                                 JS::Handle<JS::Value> aObj,
  65                                 const Optional<StringOrUnsignedLong>& aId,
  66                                 const nsAString& aRevisionId,
  67                                 ErrorResult& aRv);
  68
  69   already_AddRefed<Promise> Remove(JSContext* aCx,
  70                                    const StringOrUnsignedLong& aId,
  71                                    const nsAString& aRevisionId,
  72                                    ErrorResult& aRv);
  73
  74   already_AddRefed<Promise> Clear(JSContext* aCx,
  75                                   const nsAString& aRevisionId,
  76                                   ErrorResult& aRv);
  77
  78   void GetRevisionId(JSContext* aCx, nsAString& aRevisionId, ErrorResult& aRv);
  79
  80   already_AddRefed<Promise> GetLength(JSContext* aCx, ErrorResult& aRv);
  81
  82   already_AddRefed<WorkerDataStoreCursor> Sync(JSContext* aCx,
  83                                                const nsAString& aRevisionId,
  84                                                ErrorResult& aRv);
  85
  86   IMPL_EVENT_HANDLER(change)
  87
  88   // We don't use this for the WorkerDataStore.
  89   void SetDataStoreImpl(DataStoreImpl& aStore, ErrorResult& aRv);
  90
  91   void SetBackingDataStore(
  92     const nsMainThreadPtrHandle<DataStore>& aBackingStore);
  93
  94   void SetDataStoreChangeEventProxy(DataStoreChangeEventProxy* aEventProxy);
  95
  96 protected:
  97   virtual ~WorkerDataStore() {}
  98
  99 private:
 100   nsMainThreadPtrHandle<DataStore> mBackingStore;
 101   nsRefPtr<DataStoreChangeEventProxy> mEventProxy;
 102 };
 103
 104 class DataStoreChangeEventProxy MOZ_FINAL : public nsIDOMEventListener
 105                                           , public WorkerFeature
 106 {
 107 public:
 108   NS_DECL_THREADSAFE_ISUPPORTS
 109   NS_DECL_NSIDOMEVENTLISTENER
 110
 111   DataStoreChangeEventProxy(WorkerPrivate* aWorkerPrivate,
 112                             WorkerDataStore* aWorkerStore);
 113
 114   WorkerPrivate* GetWorkerPrivate() const;
 115
 116   WorkerDataStore* GetWorkerStore() const;
 117
 118 protected:
 119   // WorkerFeature implementation.
 120
 121   bool Notify(JSContext* aCx, Status aStatus) MOZ_OVERRIDE;
 122
 123 private:
 124   ~DataStoreChangeEventProxy() {};
 125
 126   WorkerPrivate* mWorkerPrivate;
 127
 128   nsRefPtr<WorkerDataStore> mWorkerStore;
 129
 130   bool mCleanedUp; // To specify if the worker has been cancelled.
 131
 132   // Ensure the worker and the main thread won't race to access |mCleanedUp|.
 133   Mutex mCleanUpLock;
 134 };
 135
 136 } //namespace workers
 137 } //namespace dom
 138 } //namespace mozilla
 139
 140 #endif