dom/abort/AbortController.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_AbortController_h
   8 #define mozilla_dom_AbortController_h
   9
  10 #include "mozilla/dom/BindingDeclarations.h"
  11 #include "nsCOMPtr.h"
  12 #include "nsCycleCollectionParticipant.h"
  13 #include "nsWrapperCache.h"
  14
  15 class nsIGlobalObject;
  16
  17 namespace mozilla {
  18 class ErrorResult;
  19
  20 namespace dom {
  21
  22 class AbortSignal;
  23
  24 class AbortController : public nsISupports, public nsWrapperCache {
  25  public:
  26   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  27   NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(AbortController)
  28
  29   static already_AddRefed<AbortController> Constructor(
  30       const GlobalObject& aGlobal, ErrorResult& aRv);
  31
  32   explicit AbortController(nsIGlobalObject* aGlobal);
  33
  34   JSObject* WrapObject(JSContext* aCx,
  35                        JS::Handle<JSObject*> aGivenProto) override;
  36
  37   nsIGlobalObject* GetParentObject() const;
  38
  39   AbortSignal* Signal();
  40
  41   void Abort(JSContext* aCx, JS::Handle<JS::Value> aReason);
  42
  43  protected:
  44   virtual ~AbortController();
  45
  46   nsCOMPtr<nsIGlobalObject> mGlobal;
  47   RefPtr<AbortSignal> mSignal;
  48
  49   bool mAborted;
  50   JS::Heap<JS::Value> mReason;
  51 };
  52
  53 }  // namespace dom
  54 }  // namespace mozilla
  55
  56 #endif  // mozilla_dom_AbortController_h