/* 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 nsICancelableRunnable_h_
#define nsICancelableRunnable_h_

#include "nsISupports.h"

#define NS_ICANCELABLERUNNABLE_IID \
  {0xde93dc4c, 0x5eea, 0x4eb7, {0xb6, 0xd1, 0xdb, 0xf1, 0xe0, 0xce, 0xf6, 0x5c}}

class nsICancelableRunnable : public nsISupports {
 public:
  NS_INLINE_DECL_STATIC_IID(NS_ICANCELABLERUNNABLE_IID)

  /*
   * Cancels a pending task, so that calling run() on the task is a no-op.
   * Calling cancel after the task execution has begun will be a no-op.
   * Calling this method twice is considered an error.
   *
   * @throws NS_ERROR_UNEXPECTED
   *   Indicates that the runnable has already been canceled.
   */
  virtual nsresult Cancel() = 0;

 protected:
  nsICancelableRunnable() = default;
  virtual ~nsICancelableRunnable() = default;
};

#endif  // nsICancelableRunnable_h_
