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 protocol PChildToParentStream;
   8 include IPCStream;
   9 include ChannelInfo;
  10 include PBackgroundSharedTypes;
  11
  12 include "mozilla/dom/cache/IPCUtils.h";
  13 include "mozilla/dom/FetchIPCTypes.h";
  14
  15 using HeadersGuardEnum from "mozilla/dom/HeadersBinding.h";
  16 using Namespace from "mozilla/dom/cache/Types.h";
  17 using OpenMode from "mozilla/dom/cache/Types.h";
  18 using ReferrerPolicy from "mozilla/dom/ReferrerPolicyBinding.h";
  19 using RequestCredentials from "mozilla/dom/RequestBinding.h";
  20 using RequestMode from "mozilla/dom/RequestBinding.h";
  21 using RequestCache from "mozilla/dom/RequestBinding.h";
  22 using RequestRedirect from "mozilla/dom/RequestBinding.h";
  23 using ResponseType from "mozilla/dom/ResponseBinding.h";
  24 using struct mozilla::void_t from "mozilla/ipc/IPCCore.h";
  25 using nsContentPolicyType from "nsIContentPolicy.h";
  26 using struct nsID from "nsID.h";
  27 using nsILoadInfo::CrossOriginEmbedderPolicy from "nsILoadInfo.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   IPCChannelInfo channelInfo;
  85   PrincipalInfo? principalInfo;
  86   uint32_t paddingInfo;
  87   int64_t paddingSize;
  88 };
  89
  90 struct CacheRequestResponse
  91 {
  92   CacheRequest request;
  93   CacheResponse response;
  94 };
  95
  96 struct CacheMatchArgs
  97 {
  98   CacheRequest request;
  99   CacheQueryParams params;
 100   OpenMode openMode;
 101 };
 102
 103 struct CacheMatchAllArgs
 104 {
 105   CacheRequest? maybeRequest;
 106   CacheQueryParams params;
 107   OpenMode openMode;
 108 };
 109
 110 struct CachePutAllArgs
 111 {
 112   CacheRequestResponse[] requestResponseList;
 113 };
 114
 115 struct CacheDeleteArgs
 116 {
 117   CacheRequest request;
 118   CacheQueryParams params;
 119 };
 120
 121 struct CacheKeysArgs
 122 {
 123   CacheRequest? maybeRequest;
 124   CacheQueryParams params;
 125   OpenMode openMode;
 126 };
 127
 128 struct StorageMatchArgs
 129 {
 130   CacheRequest request;
 131   CacheQueryParams params;
 132   OpenMode openMode;
 133 };
 134
 135 struct StorageHasArgs
 136 {
 137   nsString key;
 138 };
 139
 140 struct StorageOpenArgs
 141 {
 142   nsString key;
 143 };
 144
 145 struct StorageDeleteArgs
 146 {
 147   nsString key;
 148 };
 149
 150 struct StorageKeysArgs
 151 {
 152 };
 153
 154 union CacheOpArgs
 155 {
 156   CacheMatchArgs;
 157   CacheMatchAllArgs;
 158   CachePutAllArgs;
 159   CacheDeleteArgs;
 160   CacheKeysArgs;
 161   StorageMatchArgs;
 162   StorageHasArgs;
 163   StorageOpenArgs;
 164   StorageDeleteArgs;
 165   StorageKeysArgs;
 166 };
 167
 168 struct CacheMatchResult
 169 {
 170   CacheResponse? maybeResponse;
 171 };
 172
 173 struct CacheMatchAllResult
 174 {
 175   CacheResponse[] responseList;
 176 };
 177
 178 struct CachePutAllResult
 179 {
 180 };
 181
 182 struct CacheDeleteResult
 183 {
 184   bool success;
 185 };
 186
 187 struct CacheKeysResult
 188 {
 189   CacheRequest[] requestList;
 190 };
 191
 192 struct StorageMatchResult
 193 {
 194   CacheResponse? maybeResponse;
 195 };
 196
 197 struct StorageHasResult
 198 {
 199   bool success;
 200 };
 201
 202 struct StorageOpenResult
 203 {
 204   nullable PCache actor;
 205   Namespace ns;
 206 };
 207
 208 struct StorageDeleteResult
 209 {
 210   bool success;
 211 };
 212
 213 struct StorageKeysResult
 214 {
 215   nsString[] keyList;
 216 };
 217
 218 union CacheOpResult
 219 {
 220   void_t;
 221   CacheMatchResult;
 222   CacheMatchAllResult;
 223   CachePutAllResult;
 224   CacheDeleteResult;
 225   CacheKeysResult;
 226   StorageMatchResult;
 227   StorageHasResult;
 228   StorageOpenResult;
 229   StorageDeleteResult;
 230   StorageKeysResult;
 231 };
 232
 233 } // namespace cache
 234 } // namespace dom
 235 } // namespace mozilla