dom/cache/DBAction.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
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_cache_DBAction_h
   8 #define mozilla_dom_cache_DBAction_h
   9
  10 #include "mozilla/dom/cache/Action.h"
  11 #include "mozilla/RefPtr.h"
  12 #include "nsString.h"
  13
  14 class mozIStorageConnection;
  15 class nsIFile;
  16
  17 namespace mozilla::dom::cache {
  18
  19 Result<nsCOMPtr<mozIStorageConnection>, nsresult> OpenDBConnection(
  20     const CacheDirectoryMetadata& aDirectoryMetadata, nsIFile& aDBFile);
  21
  22 class DBAction : public Action {
  23  protected:
  24   // The mode specifies whether the database should already exist or if its
  25   // ok to create a new database.
  26   enum Mode { Existing, Create };
  27
  28   explicit DBAction(Mode aMode);
  29
  30   // Action objects are deleted through their base pointer
  31   virtual ~DBAction();
  32
  33   // Just as the resolver must be ref'd until resolve, you may also
  34   // ref the DB connection.  The connection can only be referenced from the
  35   // target thread and must be released upon resolve.
  36   virtual void RunWithDBOnTarget(
  37       SafeRefPtr<Resolver> aResolver,
  38       const CacheDirectoryMetadata& aDirectoryMetadata, nsIFile* aDBDir,
  39       mozIStorageConnection* aConn) = 0;
  40
  41  private:
  42   void RunOnTarget(SafeRefPtr<Resolver> aResolver,
  43                    const Maybe<CacheDirectoryMetadata>& aDirectoryMetadata,
  44                    Data* aOptionalData) override;
  45
  46   Result<nsCOMPtr<mozIStorageConnection>, nsresult> OpenConnection(
  47       const CacheDirectoryMetadata& aDirectoryMetadata, nsIFile& aDBDir);
  48
  49   const Mode mMode;
  50 };
  51
  52 class SyncDBAction : public DBAction {
  53  protected:
  54   explicit SyncDBAction(Mode aMode);
  55
  56   // Action objects are deleted through their base pointer
  57   virtual ~SyncDBAction();
  58
  59   virtual nsresult RunSyncWithDBOnTarget(
  60       const CacheDirectoryMetadata& aDirectoryMetadata, nsIFile* aDBDir,
  61       mozIStorageConnection* aConn) = 0;
  62
  63  private:
  64   virtual void RunWithDBOnTarget(
  65       SafeRefPtr<Resolver> aResolver,
  66       const CacheDirectoryMetadata& aDirectoryMetadata, nsIFile* aDBDir,
  67       mozIStorageConnection* aConn) override;
  68 };
  69
  70 }  // namespace mozilla::dom::cache
  71
  72 #endif  // mozilla_dom_cache_DBAction_h