gecko-dev/dom/quota/ClientDirectoryLock.h
Jan Varga db45cbe98b Bug 1957334 - QM: Replace uses of Nullable<Client::Type> with ClientStorageScope; r=dom-storage-reviewers,jstutte
`Nullable<ClientType>` currently allows specifying either a concrete client
type or all client types, but does not support more flexible scoping options.

`ClientStorageScope` is designed to address that limitation, with future
support planned for special purpose scopes, such as locking the metadata file
shared by client directories.

This patch updates existing code, particularly around directory locks, to use
`ClientStorageScope` in place of `Nullable<ClientType>`.

Support for additional scope types will be added in a follow-up patch. This
patch focuses on transitioning to the new abstraction.

Differential Revision: https://phabricator.services.mozilla.com/D243630
2025-04-10 05:06:55 +00:00

74 lines
2.2 KiB
C++

/* -*- 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 DOM_QUOTA_CLIENTDIRECTORYLOCK_H_
#define DOM_QUOTA_CLIENTDIRECTORYLOCK_H_
#include "nsStringFwd.h"
#include "mozilla/dom/quota/Client.h"
#include "mozilla/dom/quota/OriginDirectoryLock.h"
#include "mozilla/dom/quota/PersistenceType.h"
template <class T>
class RefPtr;
namespace mozilla {
template <typename T>
class MovingNotNull;
} // namespace mozilla
namespace mozilla::dom {
template <typename T>
struct Nullable;
} // namespace mozilla::dom
namespace mozilla::dom::quota {
enum class DirectoryLockCategory : uint8_t;
struct OriginMetadata;
class OriginScope;
class PersistenceScope;
class QuotaManager;
class UniversalDirectoryLock;
// A directory lock specialized for a given client directory (inside an origin
// directory).
class ClientDirectoryLock final : public OriginDirectoryLock {
friend class QuotaManager;
friend class UniversalDirectoryLock;
public:
using OriginDirectoryLock::OriginDirectoryLock;
// XXX This getter shouldn't exist in the root class, but since some
// consumers don't use proper casting to ClientDirectoryLock yet, we keep
// it in the root class and have explicit forwarding here.
Client::Type ClientType() const { return OriginDirectoryLock::ClientType(); }
private:
static RefPtr<ClientDirectoryLock> Create(
MovingNotNull<RefPtr<QuotaManager>> aQuotaManager,
PersistenceType aPersistenceType,
const quota::OriginMetadata& aOriginMetadata, Client::Type aClientType,
bool aExclusive);
static RefPtr<ClientDirectoryLock> Create(
MovingNotNull<RefPtr<QuotaManager>> aQuotaManager,
const PersistenceScope& aPersistenceScope,
const OriginScope& aOriginScope,
const ClientStorageScope& aClientStorageScope, bool aExclusive,
bool aInternal, ShouldUpdateLockIdTableFlag aShouldUpdateLockIdTableFlag,
DirectoryLockCategory aCategory);
};
} // namespace mozilla::dom::quota
#endif // DOM_QUOTA_CLIENTDIRECTORYLOCK_H_