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 StorageInitializedParams
  45 {
  46 };
  47
  48 struct TemporaryStorageInitializedParams
  49 {
  50 };
  51
  52 struct InitTemporaryStorageParams
  53 {
  54 };
  55
  56 struct InitializePersistentOriginParams
  57 {
  58   PrincipalInfo principalInfo;
  59 };
  60
  61 struct InitializeTemporaryOriginParams
  62 {
  63   PersistenceType persistenceType;
  64   PrincipalInfo principalInfo;
  65 };
  66
  67 struct GetFullOriginMetadataParams
  68 {
  69   PersistenceType persistenceType;
  70   PrincipalInfo principalInfo;
  71 };
  72
  73 struct AllUsageParams
  74 {
  75   bool getAll;
  76 };
  77
  78 struct OriginUsageParams
  79 {
  80   PrincipalInfo principalInfo;
  81   bool fromMemory;
  82 };
  83
  84 union UsageRequestParams
  85 {
  86   AllUsageParams;
  87   OriginUsageParams;
  88 };
  89
  90 struct ClearResetOriginParams
  91 {
  92   PrincipalInfo principalInfo;
  93   PersistenceType persistenceType;
  94   bool persistenceTypeIsExplicit;
  95   Type clientType;
  96   bool clientTypeIsExplicit;
  97 };
  98
  99 struct ResetOriginParams
 100 {
 101   ClearResetOriginParams commonParams;
 102 };
 103
 104 struct PersistedParams
 105 {
 106   PrincipalInfo principalInfo;
 107 };
 108
 109 struct PersistParams
 110 {
 111   PrincipalInfo principalInfo;
 112 };
 113
 114 struct EstimateParams
 115 {
 116   PrincipalInfo principalInfo;
 117 };
 118
 119 struct ListOriginsParams
 120 {
 121 };
 122
 123 union RequestParams
 124 {
 125   StorageNameParams;
 126   StorageInitializedParams;
 127   TemporaryStorageInitializedParams;
 128   InitTemporaryStorageParams;
 129   InitializePersistentOriginParams;
 130   InitializeTemporaryOriginParams;
 131   GetFullOriginMetadataParams;
 132   ResetOriginParams;
 133   PersistedParams;
 134   PersistParams;
 135   EstimateParams;
 136   ListOriginsParams;
 137 };
 138
 139 [ManualDealloc, ChildImpl=virtual, ParentImpl=virtual]
 140 protocol PQuota
 141 {
 142   manager PBackground;
 143
 144   manages PQuotaRequest;
 145   manages PQuotaUsageRequest;
 146
 147 parent:
 148   async __delete__();
 149
 150   async PQuotaUsageRequest(UsageRequestParams params);
 151
 152   async PQuotaRequest(RequestParams params);
 153
 154   async InitializeStorage()
 155       returns(BoolResponse response);
 156
 157   async ClearStoragesForOrigin(PersistenceType? persistenceType,
 158                                PrincipalInfo principalInfo,
 159                                Type? clientType)
 160       returns(BoolResponse response);
 161
 162   async ClearStoragesForOriginPrefix(PersistenceType? persistenceType,
 163                                      PrincipalInfo principalInfo)
 164       returns(BoolResponse response);
 165
 166   // This can only be called from some other thread in the parent process!
 167   async ClearStoragesForOriginAttributesPattern(OriginAttributesPattern pattern)
 168       returns(BoolResponse response);
 169
 170   async ClearStoragesForPrivateBrowsing()
 171       returns(BoolResponse response);
 172
 173   async ClearStorage()
 174       returns(BoolResponse response);
 175
 176   async ShutdownStorage()
 177       returns(BoolResponse response);
 178
 179   async StartIdleMaintenance();
 180
 181   async StopIdleMaintenance();
 182
 183   async AbortOperationsForProcess(ContentParentId contentParentId);
 184 };
 185
 186 } // namespace quota
 187 } // namespace dom
 188 } // namespace mozilla