diff options
author | Matt A. Tobin <mattatobin@localhost.localdomain> | 2018-02-02 04:16:08 -0500 |
---|---|---|
committer | Matt A. Tobin <mattatobin@localhost.localdomain> | 2018-02-02 04:16:08 -0500 |
commit | 5f8de423f190bbb79a62f804151bc24824fa32d8 (patch) | |
tree | 10027f336435511475e392454359edea8e25895d /dom/quota/Client.h | |
parent | 49ee0794b5d912db1f95dce6eb52d781dc210db5 (diff) | |
download | UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.gz UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.lz UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.xz UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.zip |
Add m-esr52 at 52.6.0
Diffstat (limited to 'dom/quota/Client.h')
-rw-r--r-- | dom/quota/Client.h | 151 |
1 files changed, 151 insertions, 0 deletions
diff --git a/dom/quota/Client.h b/dom/quota/Client.h new file mode 100644 index 000000000..ecbddebdf --- /dev/null +++ b/dom/quota/Client.h @@ -0,0 +1,151 @@ +/* -*- 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 mozilla_dom_quota_client_h__ +#define mozilla_dom_quota_client_h__ + +#include "mozilla/dom/quota/QuotaCommon.h" + +#include "mozilla/dom/ipc/IdType.h" + +#include "PersistenceType.h" + +class nsIRunnable; + +#define IDB_DIRECTORY_NAME "idb" +#define ASMJSCACHE_DIRECTORY_NAME "asmjs" +#define DOMCACHE_DIRECTORY_NAME "cache" + +BEGIN_QUOTA_NAMESPACE + +class QuotaManager; +class UsageInfo; + +// An abstract interface for quota manager clients. +// Each storage API must provide an implementation of this interface in order +// to participate in centralized quota and storage handling. +class Client +{ +public: + typedef mozilla::Atomic<bool> AtomicBool; + + NS_IMETHOD_(MozExternalRefCountType) + AddRef() = 0; + + NS_IMETHOD_(MozExternalRefCountType) + Release() = 0; + + enum Type { + IDB = 0, + //LS, + //APPCACHE, + ASMJS, + DOMCACHE, + TYPE_MAX + }; + + virtual Type + GetType() = 0; + + static nsresult + TypeToText(Type aType, nsAString& aText) + { + switch (aType) { + case IDB: + aText.AssignLiteral(IDB_DIRECTORY_NAME); + break; + + case ASMJS: + aText.AssignLiteral(ASMJSCACHE_DIRECTORY_NAME); + break; + + case DOMCACHE: + aText.AssignLiteral(DOMCACHE_DIRECTORY_NAME); + break; + + case TYPE_MAX: + default: + NS_NOTREACHED("Bad id value!"); + return NS_ERROR_UNEXPECTED; + } + + return NS_OK; + } + + static nsresult + TypeFromText(const nsAString& aText, Type& aType) + { + if (aText.EqualsLiteral(IDB_DIRECTORY_NAME)) { + aType = IDB; + } + else if (aText.EqualsLiteral(ASMJSCACHE_DIRECTORY_NAME)) { + aType = ASMJS; + } + else if (aText.EqualsLiteral(DOMCACHE_DIRECTORY_NAME)) { + aType = DOMCACHE; + } + else { + return NS_ERROR_FAILURE; + } + + return NS_OK; + } + + // Methods which are called on the IO thred. + virtual nsresult + InitOrigin(PersistenceType aPersistenceType, + const nsACString& aGroup, + const nsACString& aOrigin, + const AtomicBool& aCanceled, + UsageInfo* aUsageInfo) = 0; + + virtual nsresult + GetUsageForOrigin(PersistenceType aPersistenceType, + const nsACString& aGroup, + const nsACString& aOrigin, + const AtomicBool& aCanceled, + UsageInfo* aUsageInfo) = 0; + + virtual void + OnOriginClearCompleted(PersistenceType aPersistenceType, + const nsACString& aOrigin) = 0; + + virtual void + ReleaseIOThreadObjects() = 0; + + // Methods which are called on the background thred. + virtual void + AbortOperations(const nsACString& aOrigin) = 0; + + virtual void + AbortOperationsForProcess(ContentParentId aContentParentId) = 0; + + virtual void + StartIdleMaintenance() = 0; + + virtual void + StopIdleMaintenance() = 0; + + virtual void + ShutdownWorkThreads() = 0; + + // Methods which are called on the main thread. + virtual void + DidInitialize(QuotaManager* aQuotaManager) + { } + + virtual void + WillShutdown() + { } + +protected: + virtual ~Client() + { } +}; + +END_QUOTA_NAMESPACE + +#endif // mozilla_dom_quota_client_h__ |