summaryrefslogtreecommitdiffstats
path: root/dom/quota/PQuota.ipdl
blob: 0eb6fb11ed9ee12dff4657ed1a834d8c1f105c33 (plain)
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
/* 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/. */

include protocol PBackground;
include protocol PQuotaRequest;
include protocol PQuotaUsageRequest;

include PBackgroundSharedTypes;

include "mozilla/dom/quota/SerializationHelpers.h";

using mozilla::OriginAttributesPattern
  from "mozilla/OriginAttributes.h";

using mozilla::dom::quota::PersistenceType
  from "mozilla/dom/quota/PersistenceType.h";

using mozilla::dom::quota::Client::Type
  from "mozilla/dom/quota/Client.h";

using mozilla::dom::ContentParentId
  from "mozilla/dom/ipc/IdType.h";

namespace mozilla {

namespace ipc {

union BoolResponse
{
  nsresult;
  bool;
};

} // namespace ipc

namespace dom {
namespace quota {

struct StorageNameParams
{
};

struct InitializePersistentOriginParams
{
  PrincipalInfo principalInfo;
};

struct InitializeTemporaryOriginParams
{
  PersistenceType persistenceType;
  PrincipalInfo principalInfo;
};

struct GetFullOriginMetadataParams
{
  PersistenceType persistenceType;
  PrincipalInfo principalInfo;
};

struct AllUsageParams
{
  bool getAll;
};

struct OriginUsageParams
{
  PrincipalInfo principalInfo;
  bool fromMemory;
};

union UsageRequestParams
{
  AllUsageParams;
  OriginUsageParams;
};

struct ClearResetOriginParams
{
  PrincipalInfo principalInfo;
  PersistenceType persistenceType;
  bool persistenceTypeIsExplicit;
  Type clientType;
  bool clientTypeIsExplicit;
};

struct ResetOriginParams
{
  ClearResetOriginParams commonParams;
};

struct PersistedParams
{
  PrincipalInfo principalInfo;
};

struct PersistParams
{
  PrincipalInfo principalInfo;
};

struct EstimateParams
{
  PrincipalInfo principalInfo;
};

struct ListOriginsParams
{
};

union RequestParams
{
  StorageNameParams;
  InitializePersistentOriginParams;
  InitializeTemporaryOriginParams;
  GetFullOriginMetadataParams;
  ResetOriginParams;
  PersistedParams;
  PersistParams;
  EstimateParams;
  ListOriginsParams;
};

[ChildImpl=virtual, ParentImpl=virtual]
protocol PQuota
{
  manager PBackground;

  manages PQuotaRequest;
  manages PQuotaUsageRequest;

parent:
  async __delete__();

  async PQuotaUsageRequest(UsageRequestParams params);

  async PQuotaRequest(RequestParams params);

  async StorageInitialized()
      returns(BoolResponse response);

  async TemporaryStorageInitialized()
      returns(BoolResponse response);

  async InitializeStorage()
      returns(BoolResponse response);

  async InitializePersistentClient(PrincipalInfo principalInfo,
                                   Type clientType)
      returns(BoolResponse response);

  async InitializeTemporaryClient(PersistenceType persistenceType,
                                  PrincipalInfo principalInfo,
                                  Type clientType)
      returns(BoolResponse response);

  async InitializeTemporaryStorage()
      returns(BoolResponse response);

  async ClearStoragesForOrigin(PersistenceType? persistenceType,
                               PrincipalInfo principalInfo,
                               Type? clientType)
      returns(BoolResponse response);

  async ClearStoragesForOriginPrefix(PersistenceType? persistenceType,
                                     PrincipalInfo principalInfo)
      returns(BoolResponse response);

  // This can only be called from some other thread in the parent process!
  async ClearStoragesForOriginAttributesPattern(OriginAttributesPattern pattern)
      returns(BoolResponse response);

  async ClearStoragesForPrivateBrowsing()
      returns(BoolResponse response);

  async ClearStorage()
      returns(BoolResponse response);

  async ShutdownStorage()
      returns(BoolResponse response);

  async StartIdleMaintenance();

  async StopIdleMaintenance();

  async AbortOperationsForProcess(ContentParentId contentParentId);
};

} // namespace quota
} // namespace dom
} // namespace mozilla