image/ShutdownTracker.h
author Mozilla Releng Treescript <release+treescript@mozilla.org>
Fri, 16 Nov 2018 16:05:12 +0000
changeset 501264 f7da5f0188e1cdb842cef460b4e8bfd9af67f2fd
parent 344765 05849fd36220a88a50cecdb5d0b585c5c81ffb4d
child 508163 6f3709b3878117466168c40affa7bca0b60cf75b
permissions -rw-r--r--
No bug - Tagging 7473fdd1c21c00299314892ad74b10aa5af67179 with FIREFOX_64_0b10_RELEASE a=release CLOSED TREE DONTBUILD

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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/. */

/**
 * ShutdownTracker is an imagelib-global service that allows callers to check
 * whether shutdown has started.
 */

#ifndef mozilla_image_ShutdownTracker_h
#define mozilla_image_ShutdownTracker_h

namespace mozilla {
namespace image {

/**
 * ShutdownTracker is an imagelib-global service that allows callers to check
 * whether shutdown has started. It exists to avoid the need for registering
 * many 'xpcom-will-shutdown' notification observers on short-lived objects,
 * which would have an unnecessary performance cost.
 */
struct ShutdownTracker
{
  /**
   * Initialize static data. Called during imagelib module initialization.
   */
  static void Initialize();

  /**
   * Check whether shutdown has started. Callers can use this to check whether
   * it's safe to access XPCOM services; if shutdown has started, such calls
   * must be avoided.
   *
   * @return true if shutdown has already started.
   */
  static bool ShutdownHasStarted();

private:
  virtual ~ShutdownTracker() = 0;  // Forbid instantiation.
};

} // namespace image
} // namespace mozilla

#endif // mozilla_image_ShutdownTracker_h