storage/browser/quota/quota_override_handle.h

// Copyright 2020 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef STORAGE_BROWSER_QUOTA_QUOTA_OVERRIDE_HANDLE_H_
#define STORAGE_BROWSER_QUOTA_QUOTA_OVERRIDE_HANDLE_H_

#include "base/callback_forward.h"
#include "base/memory/scoped_refptr.h"
#include "base/memory/weak_ptr.h"
#include "base/sequence_checker.h"
#include "base/sequenced_task_runner.h"
#include "base/thread_annotations.h"
#include "third_party/blink/public/common/storage_key/storage_key.h"

namespace storage {

class QuotaManagerProxy;

// Used by DevTools clients and exposes the API to override and/or
// manage an active override for storage quota on a per-storage-key basis.
// QuotaOverrideHandle instances are owned by StorageHandler (DevTools client),
// and each DevTools session will have at most 1 instance.
// This class is not thread-safe. An instance must always be used from the same
// sequence. However, this sequence can be different from the one that
// QuotaManager lives on.
class COMPONENT_EXPORT(STORAGE_BROWSER) QuotaOverrideHandle {
 public:
  explicit QuotaOverrideHandle(scoped_refptr<QuotaManagerProxy> quota_manager);
  ~QuotaOverrideHandle();
  QuotaOverrideHandle(const QuotaOverrideHandle&) = delete;

  void OverrideQuotaForStorageKey(const blink::StorageKey& storage_key,
                                  absl::optional<int64_t> quota_size,
                                  base::OnceClosure callback);

 private:
  void GetUniqueId();
  void DidGetUniqueId();
  void DidGetOverrideHandleId(int id);

  SEQUENCE_CHECKER(sequence_checker_);

  const scoped_refptr<QuotaManagerProxy> quota_manager_proxy_
      GUARDED_BY_CONTEXT(sequence_checker_);
  absl::optional<int> id_ GUARDED_BY_CONTEXT(sequence_checker_);
  std::vector<base::OnceClosure> override_callback_queue_
      GUARDED_BY_CONTEXT(sequence_checker_);

  base::WeakPtrFactory<QuotaOverrideHandle> weak_ptr_factory_
      GUARDED_BY_CONTEXT(sequence_checker_){this};
};

}  // namespace storage

#endif  // STORAGE_BROWSER_QUOTA_QUOTA_OVERRIDE_HANDLE_H_