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

#include "mozilla/LinkedList.h"
#include "nsISupports.h"
#include "nsThreadUtils.h"

class nsIRunnable;
class TargetShutdownTaskSet;

#define NS_ITARGETSHUTDOWNTASK_IID \
  {0xb08647aa, 0xcfb5, 0x4630, {0x8e, 0x26, 0x9a, 0xbe, 0xb3, 0x3f, 0x08, 0x40}}

// A task to be run on an event target when it begins shutting down.
//
// See `nsIEventTarget::RegisterShutdownTask` in `nsIEventTarget.idl`
// for more documentation.
class NS_NO_VTABLE nsITargetShutdownTask
    : public nsISupports,
      private mozilla::LinkedListElement<RefPtr<nsITargetShutdownTask>> {
  // Allow TargetShutdownTaskSet to manage the list links.
  friend class TargetShutdownTaskSet;
  friend class mozilla::LinkedList<RefPtr<nsITargetShutdownTask>>;
  friend class mozilla::LinkedListElement<RefPtr<nsITargetShutdownTask>>;

 public:
  NS_INLINE_DECL_STATIC_IID(NS_ITARGETSHUTDOWNTASK_IID)

  virtual void TargetShutdown() = 0;

  already_AddRefed<nsIRunnable> AsRunnable() {
    // FIXME: Try QI to nsINamed if available?
    return mozilla::NewRunnableMethod("nsITargetShutdownTask::TargetShutdown",
                                      this,
                                      &nsITargetShutdownTask::TargetShutdown);
  }
};

#endif