diff -r 000000000000 -r 6474c204b198 dom/quota/Client.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/dom/quota/Client.h Wed Dec 31 06:09:35 2014 +0100 @@ -0,0 +1,132 @@ +/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* vim: set ts=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 "PersistenceType.h" + +class nsIOfflineStorage; +class nsIRunnable; + +#define IDB_DIRECTORY_NAME "idb" +#define ASMJSCACHE_DIRECTORY_NAME "asmjs" + +BEGIN_QUOTA_NAMESPACE + +class OriginOrPatternString; +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: + NS_IMETHOD_(MozExternalRefCountType) + AddRef() = 0; + + NS_IMETHOD_(MozExternalRefCountType) + Release() = 0; + + enum Type { + IDB = 0, + //LS, + //APPCACHE, + ASMJS, + 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 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 { + 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, + UsageInfo* aUsageInfo) = 0; + + virtual nsresult + GetUsageForOrigin(PersistenceType aPersistenceType, + const nsACString& aGroup, + const nsACString& aOrigin, + UsageInfo* aUsageInfo) = 0; + + virtual void + OnOriginClearCompleted(PersistenceType aPersistenceType, + const OriginOrPatternString& aOriginOrPattern) = 0; + + virtual void + ReleaseIOThreadObjects() = 0; + + // Methods which are called on the main thred. + virtual bool + IsFileServiceUtilized() = 0; + + virtual bool + IsTransactionServiceActivated() = 0; + + virtual void + WaitForStoragesToComplete(nsTArray& aStorages, + nsIRunnable* aCallback) = 0; + + virtual void + AbortTransactionsForStorage(nsIOfflineStorage* aStorage) = 0; + + virtual bool + HasTransactionsForStorage(nsIOfflineStorage* aStorage) = 0; + + virtual void + ShutdownTransactionService() = 0; + +protected: + virtual ~Client() + { } +}; + +END_QUOTA_NAMESPACE + +#endif // mozilla_dom_quota_client_h__