1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
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__
|