dom/serviceworkers/ServiceWorkerShutdownState.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 DOM_SERVICEWORKERS_SERVICEWORKERSHUTDOWNSTATE_H_
   8 #define DOM_SERVICEWORKERS_SERVICEWORKERSHUTDOWNSTATE_H_
   9
  10 #include <cstdint>
  11
  12 #include "ipc/EnumSerializer.h"
  13 #include "mozilla/dom/ServiceWorkerOpArgs.h"
  14
  15 namespace mozilla::dom {
  16
  17 class ServiceWorkerShutdownState {
  18  public:
  19   // Represents the "location" of the shutdown message or completion of
  20   // shutdown.
  21   enum class Progress {
  22     ParentProcessMainThread,
  23     ParentProcessIpdlBackgroundThread,
  24     ContentProcessWorkerLauncherThread,
  25     ContentProcessMainThread,
  26     ShutdownCompleted,
  27     EndGuard_,
  28   };
  29
  30   ServiceWorkerShutdownState();
  31
  32   ~ServiceWorkerShutdownState();
  33
  34   const char* GetProgressString() const;
  35
  36   void SetProgress(Progress aProgress);
  37
  38  private:
  39   Progress mProgress;
  40 };
  41
  42 // Asynchronously reports that shutdown has progressed to the calling thread
  43 // if aArgs is for shutdown. If aShutdownCompleted is true, aArgs must be for
  44 // shutdown.
  45 void MaybeReportServiceWorkerShutdownProgress(const ServiceWorkerOpArgs& aArgs,
  46                                               bool aShutdownCompleted = false);
  47
  48 }  // namespace mozilla::dom
  49
  50 namespace IPC {
  51
  52 using Progress = mozilla::dom::ServiceWorkerShutdownState::Progress;
  53
  54 template <>
  55 struct ParamTraits<Progress>
  56     : public ContiguousEnumSerializer<
  57           Progress, Progress::ParentProcessMainThread, Progress::EndGuard_> {};
  58
  59 }  // namespace IPC
  60
  61 #endif  // DOM_SERVICEWORKERS_SERVICEWORKERSHUTDOWNSTATE_H_