dom/quota/DirectoryLock.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   5  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef DOM_QUOTA_DIRECTORYLOCK_H_
   8 #define DOM_QUOTA_DIRECTORYLOCK_H_
   9
  10 #include "nsTArrayForwardDeclare.h"
  11 #include "mozilla/dom/Nullable.h"
  12 #include "mozilla/dom/quota/Client.h"
  13 #include "mozilla/dom/quota/PersistenceType.h"
  14
  15 template <class T>
  16 class RefPtr;
  17
  18 namespace mozilla::dom::quota {
  19
  20 class ClientDirectoryLock;
  21 enum class DirectoryLockCategory : uint8_t;
  22 struct OriginMetadata;
  23
  24 // Basic directory lock interface shared by all other directory lock classes.
  25 // The class must contain pure virtual functions only to avoid problems with
  26 // multiple inheritance.
  27 class NS_NO_VTABLE DirectoryLock {
  28  public:
  29   NS_INLINE_DECL_PURE_VIRTUAL_REFCOUNTING
  30
  31   virtual int64_t Id() const = 0;
  32
  33   virtual DirectoryLockCategory Category() const = 0;
  34
  35   virtual bool Acquired() const = 0;
  36
  37   virtual bool MustWait() const = 0;
  38
  39   virtual nsTArray<RefPtr<DirectoryLock>> LocksMustWaitFor() const = 0;
  40
  41   virtual bool Dropped() const = 0;
  42
  43   virtual RefPtr<BoolPromise> Acquire() = 0;
  44
  45   virtual void AcquireImmediately() = 0;
  46
  47   virtual void AssertIsAcquiredExclusively() = 0;
  48
  49   virtual void Drop() = 0;
  50
  51   virtual void OnInvalidate(std::function<void()>&& aCallback) = 0;
  52
  53   virtual void Log() const = 0;
  54 };
  55
  56 // A directory lock specialized for a given origin directory.
  57 class NS_NO_VTABLE OriginDirectoryLock : public DirectoryLock {
  58  public:
  59   // 'Get' prefix is to avoid name collisions with the enum
  60   virtual PersistenceType GetPersistenceType() const = 0;
  61
  62   virtual quota::OriginMetadata OriginMetadata() const = 0;
  63
  64   virtual const nsACString& Origin() const = 0;
  65 };
  66
  67 // A directory lock specialized for a given client directory (inside an origin
  68 // directory).
  69 class NS_NO_VTABLE ClientDirectoryLock : public OriginDirectoryLock {
  70  public:
  71   virtual Client::Type ClientType() const = 0;
  72 };
  73
  74 // A directory lock for universal use. A universal lock can handle any possible
  75 // combination of nullable persistence type, origin scope and nullable client
  76 // type.
  77 //
  78 // For example, if the persistence type is set to null, origin scope is null
  79 // and the client type is set to Client::IDB, then the lock will cover
  80 // <profile>/storage/*/*/idb
  81 //
  82 // If no property is set, then the lock will cover the entire storage directory
  83 // and its subdirectories.
  84 class UniversalDirectoryLock : public DirectoryLock {
  85  public:
  86   // XXX Rename to NullablePersistenceTypeRef.
  87   virtual const Nullable<PersistenceType>& NullablePersistenceType() const = 0;
  88
  89   // XXX Rename to OriginScopeRef.
  90   virtual const OriginScope& GetOriginScope() const = 0;
  91
  92   // XXX Rename to NullableClientTypeRef.
  93   virtual const Nullable<Client::Type>& NullableClientType() const = 0;
  94
  95   virtual RefPtr<ClientDirectoryLock> SpecializeForClient(
  96       PersistenceType aPersistenceType, const OriginMetadata& aOriginMetadata,
  97       Client::Type aClientType) const = 0;
  98 };
  99
 100 }  // namespace mozilla::dom::quota
 101
 102 #endif  // DOM_QUOTA_DIRECTORYLOCK_H_