dom/quota/PQuota.ipdl

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   3  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 include protocol PBackground;
   6 include protocol PQuotaRequest;
   7 include protocol PQuotaUsageRequest;
   8
   9 include PBackgroundSharedTypes;
  10
  11 include "mozilla/dom/quota/SerializationHelpers.h";
  12
  13 using mozilla::OriginAttributesPattern
  14   from "mozilla/OriginAttributes.h";
  15
  16 using mozilla::dom::quota::PersistenceType
  17   from "mozilla/dom/quota/PersistenceType.h";
  18
  19 using mozilla::dom::quota::Client::Type
  20   from "mozilla/dom/quota/Client.h";
  21
  22 using mozilla::dom::ContentParentId
  23   from "mozilla/dom/ipc/IdType.h";
  24
  25 namespace mozilla {
  26
  27 namespace ipc {
  28
  29 union BoolResponse
  30 {
  31   nsresult;
  32   bool;
  33 };
  34
  35 } // namespace ipc
  36
  37 namespace dom {
  38 namespace quota {
  39
  40 struct StorageNameParams
  41 {
  42 };
  43
  44 struct InitializePersistentOriginParams
  45 {
  46   PrincipalInfo principalInfo;
  47 };
  48
  49 struct InitializeTemporaryOriginParams
  50 {
  51   PersistenceType persistenceType;
  52   PrincipalInfo principalInfo;
  53 };
  54
  55 struct GetFullOriginMetadataParams
  56 {
  57   PersistenceType persistenceType;
  58   PrincipalInfo principalInfo;
  59 };
  60
  61 struct AllUsageParams
  62 {
  63   bool getAll;
  64 };
  65
  66 struct OriginUsageParams
  67 {
  68   PrincipalInfo principalInfo;
  69   bool fromMemory;
  70 };
  71
  72 union UsageRequestParams
  73 {
  74   AllUsageParams;
  75   OriginUsageParams;
  76 };
  77
  78 struct ClearResetOriginParams
  79 {
  80   PrincipalInfo principalInfo;
  81   PersistenceType persistenceType;
  82   bool persistenceTypeIsExplicit;
  83   Type clientType;
  84   bool clientTypeIsExplicit;
  85 };
  86
  87 struct ResetOriginParams
  88 {
  89   ClearResetOriginParams commonParams;
  90 };
  91
  92 struct PersistedParams
  93 {
  94   PrincipalInfo principalInfo;
  95 };
  96
  97 struct PersistParams
  98 {
  99   PrincipalInfo principalInfo;
 100 };
 101
 102 struct EstimateParams
 103 {
 104   PrincipalInfo principalInfo;
 105 };
 106
 107 struct ListOriginsParams
 108 {
 109 };
 110
 111 union RequestParams
 112 {
 113   StorageNameParams;
 114   InitializePersistentOriginParams;
 115   InitializeTemporaryOriginParams;
 116   GetFullOriginMetadataParams;
 117   ResetOriginParams;
 118   PersistedParams;
 119   PersistParams;
 120   EstimateParams;
 121   ListOriginsParams;
 122 };
 123
 124 [ChildImpl=virtual, ParentImpl=virtual]
 125 protocol PQuota
 126 {
 127   manager PBackground;
 128
 129   manages PQuotaRequest;
 130   manages PQuotaUsageRequest;
 131
 132 parent:
 133   async __delete__();
 134
 135   async PQuotaUsageRequest(UsageRequestParams params);
 136
 137   async PQuotaRequest(RequestParams params);
 138
 139   async StorageInitialized()
 140       returns(BoolResponse response);
 141
 142   async TemporaryStorageInitialized()
 143       returns(BoolResponse response);
 144
 145   async InitializeStorage()
 146       returns(BoolResponse response);
 147
 148   async InitializePersistentClient(PrincipalInfo principalInfo,
 149                                    Type clientType)
 150       returns(BoolResponse response);
 151
 152   async InitializeTemporaryClient(PersistenceType persistenceType,
 153                                   PrincipalInfo principalInfo,
 154                                   Type clientType)
 155       returns(BoolResponse response);
 156
 157   async InitializeTemporaryStorage()
 158       returns(BoolResponse response);
 159
 160   async ClearStoragesForOrigin(PersistenceType? persistenceType,
 161                                PrincipalInfo principalInfo,
 162                                Type? clientType)
 163       returns(BoolResponse response);
 164
 165   async ClearStoragesForOriginPrefix(PersistenceType? persistenceType,
 166                                      PrincipalInfo principalInfo)
 167       returns(BoolResponse response);
 168
 169   // This can only be called from some other thread in the parent process!
 170   async ClearStoragesForOriginAttributesPattern(OriginAttributesPattern pattern)
 171       returns(BoolResponse response);
 172
 173   async ClearStoragesForPrivateBrowsing()
 174       returns(BoolResponse response);
 175
 176   async ClearStorage()
 177       returns(BoolResponse response);
 178
 179   async ShutdownStorage()
 180       returns(BoolResponse response);
 181
 182   async StartIdleMaintenance();
 183
 184   async StopIdleMaintenance();
 185
 186   async AbortOperationsForProcess(ContentParentId contentParentId);
 187 };
 188
 189 } // namespace quota
 190 } // namespace dom
 191 } // namespace mozilla