gecko-dev/dom/promise/AbortablePromise.h
2015-05-03 15:32:37 -04:00

67 lines
2.0 KiB
C++

/* -*- 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_AbortablePromise_h__
#define mozilla_dom_AbortablePromise_h__
#include "js/TypeDecls.h"
#include "mozilla/dom/Promise.h"
#include "mozilla/dom/CallbackObject.h"
namespace mozilla {
namespace dom {
class AbortCallback;
class PromiseNativeAbortCallback;
class AbortablePromise
: public Promise
{
public:
NS_DECL_ISUPPORTS_INHERITED
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(AbortablePromise, Promise)
public:
// It is the same as Promise::Create except that this takes an extra
// aAbortCallback parameter to set the abort callback handler.
static already_AddRefed<AbortablePromise>
Create(nsIGlobalObject* aGlobal, PromiseNativeAbortCallback& aAbortCallback,
ErrorResult& aRv);
protected:
// Constructor used to create native AbortablePromise with C++.
AbortablePromise(nsIGlobalObject* aGlobal,
PromiseNativeAbortCallback& aAbortCallback);
// Constructor used to create AbortablePromise for JavaScript. It should be
// called by the static AbortablePromise::Constructor.
explicit AbortablePromise(nsIGlobalObject* aGlobal);
virtual ~AbortablePromise();
public:
virtual JSObject*
WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto) override;
static already_AddRefed<AbortablePromise>
Constructor(const GlobalObject& aGlobal, PromiseInit& aInit,
AbortCallback& aAbortCallback, ErrorResult& aRv);
void Abort();
private:
void DoAbort();
// The callback functions to abort the promise.
CallbackObjectHolder<AbortCallback,
PromiseNativeAbortCallback> mAbortCallback;
};
} // namespace dom
} // namespace mozilla
#endif // mozilla_dom_AbortablePromise_h__