File: Cache.h

package info (click to toggle)
firefox 143.0.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,617,328 kB
  • sloc: cpp: 7,478,492; javascript: 6,417,157; ansic: 3,720,058; python: 1,396,372; xml: 627,523; asm: 438,677; java: 186,156; sh: 63,477; makefile: 19,171; objc: 13,059; perl: 12,983; yacc: 4,583; cs: 3,846; pascal: 3,405; lex: 1,720; ruby: 1,003; exp: 762; php: 436; lisp: 258; awk: 247; sql: 66; sed: 53; csh: 10
file content (134 lines) | stat: -rw-r--r-- 4,650 bytes parent folder | download | duplicates (4)
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
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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/. */

#ifndef mozilla_dom_cache_Cache_h
#define mozilla_dom_cache_Cache_h

#include "mozilla/dom/cache/TypeUtils.h"
#include "mozilla/dom/cache/Types.h"
#include "nsCOMPtr.h"
#include "nsISupportsImpl.h"
#include "nsString.h"
#include "nsWrapperCache.h"

class nsIGlobalObject;

namespace mozilla {

class ErrorResult;

namespace dom {

class OwningRequestOrUTF8String;
class Promise;
struct CacheQueryOptions;
class RequestOrUTF8String;
class Response;
template <typename T>
class Optional;
template <typename T>
class Sequence;
enum class CallerType : uint32_t;

namespace cache {

class AutoChildOpArgs;
class CacheChild;

enum class PutStatusPolicy { Default, RequireOK };
bool IsValidPutRequestURL(const nsACString& aUrl, ErrorResult& aRv);
bool IsValidPutRequestMethod(const RequestOrUTF8String& aRequest,
                             ErrorResult& aRv);
bool IsValidPutRequestMethod(const Request& aRequest, ErrorResult& aRv);
bool IsValidPutResponseStatus(Response& aResponse, PutStatusPolicy aPolicy,
                              ErrorResult& aRv);

class Cache final : public nsISupports,
                    public nsWrapperCache,
                    public TypeUtils,
                    public CacheChildListener {
 public:
  Cache(nsIGlobalObject* aGlobal, CacheChild* aActor, Namespace aNamespace);

  static bool CachesEnabled(JSContext* aCx, JSObject*);

  // webidl interface methods
  already_AddRefed<Promise> Match(JSContext* aCx,
                                  const RequestOrUTF8String& aRequest,
                                  const CacheQueryOptions& aOptions,
                                  ErrorResult& aRv);
  already_AddRefed<Promise> MatchAll(
      JSContext* aCx, const Optional<RequestOrUTF8String>& aRequest,
      const CacheQueryOptions& aOptions, ErrorResult& aRv);
  already_AddRefed<Promise> Add(JSContext* aContext,
                                const RequestOrUTF8String& aRequest,
                                CallerType aCallerType, ErrorResult& aRv);
  already_AddRefed<Promise> AddAll(
      JSContext* aContext, const Sequence<OwningRequestOrUTF8String>& aRequests,
      CallerType aCallerType, ErrorResult& aRv);
  already_AddRefed<Promise> Put(JSContext* aCx,
                                const RequestOrUTF8String& aRequest,
                                Response& aResponse, ErrorResult& aRv);
  already_AddRefed<Promise> Delete(JSContext* aCx,
                                   const RequestOrUTF8String& aRequest,
                                   const CacheQueryOptions& aOptions,
                                   ErrorResult& aRv);
  already_AddRefed<Promise> Keys(JSContext* aCx,
                                 const Optional<RequestOrUTF8String>& aRequest,
                                 const CacheQueryOptions& aParams,
                                 ErrorResult& aRv);

  // binding methods
  nsISupports* GetParentObject() const;
  virtual JSObject* WrapObject(JSContext* aContext,
                               JS::Handle<JSObject*> aGivenProto) override;

  // Called when CacheChild actor is being destroyed.
  // Overrides CacheChildListener method
  void OnActorDestroy(CacheChild* aActor) override;

  // TypeUtils methods
  virtual nsIGlobalObject* GetGlobalObject() const override;

#ifdef DEBUG
  virtual void AssertOwningThread() const override;
#endif

 private:
  class FetchHandler;

  ~Cache();

  // Called when we're destroyed or CCed.
  void DisconnectFromActor();

  already_AddRefed<Promise> ExecuteOp(AutoChildOpArgs& aOpArgs,
                                      ErrorResult& aRv);

  already_AddRefed<Promise> AddAll(const GlobalObject& aGlobal,
                                   nsTArray<SafeRefPtr<Request>>&& aRequestList,
                                   CallerType aCallerType, ErrorResult& aRv);

  already_AddRefed<Promise> PutAll(
      JSContext* aCx, const nsTArray<SafeRefPtr<Request>>& aRequestList,
      const nsTArray<RefPtr<Response>>& aResponseList, ErrorResult& aRv);

  OpenMode GetOpenMode() const;

  nsCOMPtr<nsIGlobalObject> mGlobal;
  CacheChild* mActor;
  const Namespace mNamespace;

 public:
  NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(Cache)
};

}  // namespace cache
}  // namespace dom
}  // namespace mozilla

#endif  // mozilla_dom_Cache_h