dom/serviceworkers/FetchEventOpParent.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_fetcheventopparent_h__
   8 #define mozilla_dom_fetcheventopparent_h__
   9
  10 #include "nsISupports.h"
  11
  12 #include "mozilla/dom/FetchEventOpProxyParent.h"
  13 #include "mozilla/dom/PFetchEventOpParent.h"
  14
  15 namespace mozilla::dom {
  16
  17 class FetchEventOpParent final : public PFetchEventOpParent {
  18   friend class PFetchEventOpParent;
  19
  20  public:
  21   NS_INLINE_DECL_REFCOUNTING(FetchEventOpParent)
  22
  23   FetchEventOpParent() = default;
  24
  25   // Transition from the Pending state to the Started state. Returns the preload
  26   // response and response end args, if it has already arrived.
  27   std::tuple<Maybe<ParentToParentInternalResponse>, Maybe<ResponseEndArgs>>
  28   OnStart(
  29       MovingNotNull<RefPtr<FetchEventOpProxyParent>> aFetchEventOpProxyParent);
  30
  31   // Transition from the Started state to the Finished state.
  32   void OnFinish();
  33
  34  private:
  35   ~FetchEventOpParent() = default;
  36
  37   // IPDL methods
  38
  39   mozilla::ipc::IPCResult RecvPreloadResponse(
  40       ParentToParentInternalResponse&& aResponse);
  41
  42   mozilla::ipc::IPCResult RecvPreloadResponseTiming(ResponseTiming&& aTiming);
  43
  44   mozilla::ipc::IPCResult RecvPreloadResponseEnd(ResponseEndArgs&& aArgs);
  45
  46   void ActorDestroy(ActorDestroyReason) override;
  47
  48   struct Pending {
  49     Maybe<ParentToParentInternalResponse> mPreloadResponse;
  50     Maybe<ResponseTiming> mTiming;
  51     Maybe<ResponseEndArgs> mEndArgs;
  52   };
  53
  54   struct Started {
  55     NotNull<RefPtr<FetchEventOpProxyParent>> mFetchEventOpProxyParent;
  56   };
  57
  58   struct Finished {};
  59
  60   using State = Variant<Pending, Started, Finished>;
  61
  62   // Tracks the state of the fetch event.
  63   //
  64   // Pending:  the fetch event is waiting in RemoteWorkerController::mPendingOps
  65   //           and if the preload response arrives, we have to save it.
  66   // Started:  the FetchEventOpProxyParent has been created, and if the preload
  67   //           response arrives then we should forward it.
  68   // Finished: the response has been propagated to the parent process, if the
  69   //           preload response arrives now then we simply drop it.
  70   State mState = AsVariant(Pending());
  71 };
  72
  73 }  // namespace mozilla::dom
  74
  75 #endif  // mozilla_dom_fetcheventopparent_h__