dom/cache/CacheTypes.ipdlh

   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
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 include protocol PCache;
   6 include protocol PCacheStreamControl;
   7 include IPCStream;
   8 include PBackgroundSharedTypes;
   9
  10 include "mozilla/dom/cache/IPCUtils.h";
  11 include "mozilla/dom/FetchIPCTypes.h";
  12 include "mozilla/ipc/TransportSecurityInfoUtils.h";
  13
  14 using mozilla::dom::HeadersGuardEnum from "mozilla/dom/HeadersBinding.h";
  15 using mozilla::dom::cache::Namespace from "mozilla/dom/cache/Types.h";
  16 using mozilla::dom::cache::OpenMode from "mozilla/dom/cache/Types.h";
  17 using mozilla::dom::ReferrerPolicy from "mozilla/dom/ReferrerPolicyBinding.h";
  18 using mozilla::dom::RequestCredentials from "mozilla/dom/RequestBinding.h";
  19 using mozilla::dom::RequestMode from "mozilla/dom/RequestBinding.h";
  20 using mozilla::dom::RequestCache from "mozilla/dom/RequestBinding.h";
  21 using mozilla::dom::RequestRedirect from "mozilla/dom/RequestBinding.h";
  22 using mozilla::dom::ResponseType from "mozilla/dom/ResponseBinding.h";
  23 using mozilla::void_t from "mozilla/ipc/IPCCore.h";
  24 using nsContentPolicyType from "nsIContentPolicy.h";
  25 using struct nsID from "nsID.h";
  26 using nsILoadInfo::CrossOriginEmbedderPolicy from "nsILoadInfo.h";
  27 [RefCounted] using class nsITransportSecurityInfo from "nsITransportSecurityInfo.h";
  28
  29 namespace mozilla {
  30 namespace dom {
  31 namespace cache {
  32
  33 struct CacheQueryParams
  34 {
  35   bool ignoreSearch;
  36   bool ignoreMethod;
  37   bool ignoreVary;
  38   bool cacheNameSet;
  39   nsString cacheName;
  40 };
  41
  42 struct CacheReadStream
  43 {
  44   nsID id;
  45   nullable PCacheStreamControl control;
  46   IPCStream? stream;
  47 };
  48
  49 struct HeadersEntry
  50 {
  51   nsCString name;
  52   nsCString value;
  53 };
  54 struct CacheRequest
  55 {
  56   nsCString method;
  57   nsCString urlWithoutQuery;
  58   nsCString urlQuery;
  59   nsCString urlFragment;
  60   HeadersEntry[] headers;
  61   HeadersGuardEnum headersGuard;
  62   nsString referrer;
  63   ReferrerPolicy referrerPolicy;
  64   RequestMode mode;
  65   RequestCredentials credentials;
  66   CacheReadStream? body;
  67   nsContentPolicyType contentPolicyType;
  68   RequestCache requestCache;
  69   RequestRedirect requestRedirect;
  70   nsString integrity;
  71   CrossOriginEmbedderPolicy loadingEmbedderPolicy;
  72   PrincipalInfo? principalInfo;
  73 };
  74
  75 struct CacheResponse
  76 {
  77   ResponseType type;
  78   nsCString[] urlList;
  79   uint32_t status;
  80   nsCString statusText;
  81   HeadersEntry[] headers;
  82   HeadersGuardEnum headersGuard;
  83   CacheReadStream? body;
  84   nullable nsITransportSecurityInfo securityInfo;
  85   PrincipalInfo? principalInfo;
  86   uint32_t paddingInfo;
  87   int64_t paddingSize;
  88   RequestCredentials credentials;
  89 };
  90
  91 struct CacheRequestResponse
  92 {
  93   CacheRequest request;
  94   CacheResponse response;
  95 };
  96
  97 struct CacheMatchArgs
  98 {
  99   CacheRequest request;
 100   CacheQueryParams params;
 101   OpenMode openMode;
 102 };
 103
 104 struct CacheMatchAllArgs
 105 {
 106   CacheRequest? maybeRequest;
 107   CacheQueryParams params;
 108   OpenMode openMode;
 109 };
 110
 111 struct CachePutAllArgs
 112 {
 113   CacheRequestResponse[] requestResponseList;
 114 };
 115
 116 struct CacheDeleteArgs
 117 {
 118   CacheRequest request;
 119   CacheQueryParams params;
 120 };
 121
 122 struct CacheKeysArgs
 123 {
 124   CacheRequest? maybeRequest;
 125   CacheQueryParams params;
 126   OpenMode openMode;
 127 };
 128
 129 struct StorageMatchArgs
 130 {
 131   CacheRequest request;
 132   CacheQueryParams params;
 133   OpenMode openMode;
 134 };
 135
 136 struct StorageHasArgs
 137 {
 138   nsString key;
 139 };
 140
 141 struct StorageOpenArgs
 142 {
 143   nsString key;
 144 };
 145
 146 struct StorageDeleteArgs
 147 {
 148   nsString key;
 149 };
 150
 151 struct StorageKeysArgs
 152 {
 153 };
 154
 155 union CacheOpArgs
 156 {
 157   CacheMatchArgs;
 158   CacheMatchAllArgs;
 159   CachePutAllArgs;
 160   CacheDeleteArgs;
 161   CacheKeysArgs;
 162   StorageMatchArgs;
 163   StorageHasArgs;
 164   StorageOpenArgs;
 165   StorageDeleteArgs;
 166   StorageKeysArgs;
 167 };
 168
 169 struct CacheMatchResult
 170 {
 171   CacheResponse? maybeResponse;
 172 };
 173
 174 struct CacheMatchAllResult
 175 {
 176   CacheResponse[] responseList;
 177 };
 178
 179 struct CachePutAllResult
 180 {
 181 };
 182
 183 struct CacheDeleteResult
 184 {
 185   bool success;
 186 };
 187
 188 struct CacheKeysResult
 189 {
 190   CacheRequest[] requestList;
 191 };
 192
 193 struct StorageMatchResult
 194 {
 195   CacheResponse? maybeResponse;
 196 };
 197
 198 struct StorageHasResult
 199 {
 200   bool success;
 201 };
 202
 203 struct StorageOpenResult
 204 {
 205   nullable PCache actor;
 206   Namespace ns;
 207 };
 208
 209 struct StorageDeleteResult
 210 {
 211   bool success;
 212 };
 213
 214 struct StorageKeysResult
 215 {
 216   nsString[] keyList;
 217 };
 218
 219 union CacheOpResult
 220 {
 221   void_t;
 222   CacheMatchResult;
 223   CacheMatchAllResult;
 224   CachePutAllResult;
 225   CacheDeleteResult;
 226   CacheKeysResult;
 227   StorageMatchResult;
 228   StorageHasResult;
 229   StorageOpenResult;
 230   StorageDeleteResult;
 231   StorageKeysResult;
 232 };
 233
 234 } // namespace cache
 235 } // namespace dom
 236 } // namespace mozilla