dom/abort/AbortSignal.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_AbortSignal_h
   8 #define mozilla_dom_AbortSignal_h
   9
  10 #include "mozilla/RefPtr.h"
  11 #include "mozilla/dom/AbortFollower.h"
  12 #include "mozilla/DOMEventTargetHelper.h"
  13
  14 namespace mozilla::dom {
  15
  16 // AbortSignal the spec concept includes the concept of a child signal
  17 // "following" a parent signal -- internally, adding abort steps to the parent
  18 // signal that will then signal abort on the child signal -- to propagate
  19 // signaling abort from one signal to another.  See
  20 // <https://dom.spec.whatwg.org/#abortsignal-follow>.
  21 //
  22 // This requires that AbortSignal also inherit from AbortFollower.
  23 //
  24 // This ability to follow isn't directly exposed in the DOM; as of this writing
  25 // it appears only to be used internally in the Fetch API.  It might be a good
  26 // idea to split AbortSignal into an implementation that can follow, and an
  27 // implementation that can't, to provide this complexity only when it's needed.
  28 class AbortSignal : public DOMEventTargetHelper, public AbortSignalImpl {
  29  public:
  30   NS_DECL_ISUPPORTS_INHERITED
  31   NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS_INHERITED(AbortSignal,
  32                                                          DOMEventTargetHelper)
  33
  34   AbortSignal(nsIGlobalObject* aGlobalObject, bool aAborted,
  35               JS::Handle<JS::Value> aReason);
  36
  37   JSObject* WrapObject(JSContext* aCx,
  38                        JS::Handle<JSObject*> aGivenProto) override;
  39
  40   IMPL_EVENT_HANDLER(abort);
  41
  42   static already_AddRefed<AbortSignal> Abort(GlobalObject& aGlobal,
  43                                              JS::Handle<JS::Value> aReason);
  44
  45   static already_AddRefed<AbortSignal> Timeout(GlobalObject& aGlobal,
  46                                                uint64_t aMilliseconds,
  47                                                ErrorResult& aRv);
  48
  49   static already_AddRefed<AbortSignal> Any(
  50       GlobalObject& aGlobal,
  51       const Sequence<OwningNonNull<AbortSignal>>& aSignals);
  52   static already_AddRefed<AbortSignal> Any(
  53       nsIGlobalObject* aGlobal,
  54       const Span<const OwningNonNull<AbortSignal>>& aSignals);
  55
  56   void ThrowIfAborted(JSContext* aCx, ErrorResult& aRv);
  57
  58   virtual bool IsTaskSignal() const { return false; }
  59
  60   bool Dependent() const;
  61
  62  protected:
  63   ~AbortSignal();
  64
  65   void MakeDependentOn(AbortSignal* aSignal);
  66
  67   void SignalAbortWithDependents() override;
  68
  69   void RunAbortSteps() override;
  70
  71   nsTArray<WeakPtr<AbortSignal>> mSourceSignals;
  72   nsTArray<RefPtr<AbortSignal>> mDependentSignals;
  73
  74   bool mDependent;
  75 };
  76
  77 }  // namespace mozilla::dom
  78
  79 #endif  // mozilla_dom_AbortSignal_h