author Jorg K <>
Mon, 01 Jun 2015 17:42:49 +0200
changeset 278928 4f371fcc09ccf34e3aa304c9e9f5a9c10496b8e8
parent 276648 7701abd924856d65acbf9927629cf27dd2335ec1
child 285284 6454f52da8b34327e500dae2a4e630b40324e83b
permissions -rw-r--r--
Bug 1169996 - Don't lose eEditorMailMask; r=ehsan

/* -*- 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 */

 * DecodePool manages the threads used for decoding raster images.

#ifndef mozilla_image_DecodePool_h
#define mozilla_image_DecodePool_h

#include "mozilla/Mutex.h"
#include "mozilla/StaticPtr.h"
#include "nsCOMArray.h"
#include "nsCOMPtr.h"
#include "nsIEventTarget.h"
#include "nsIObserver.h"
#include "nsRefPtr.h"

class nsIThread;
class nsIThreadPool;

namespace mozilla {
namespace image {

class Decoder;
class DecodePoolImpl;

 * DecodePool is a singleton class that manages decoding of raster images. It
 * owns a pool of image decoding threads that are used for asynchronous
 * decoding.
 * DecodePool allows callers to run a decoder, handling management of the
 * decoder's lifecycle and whether it executes on the main thread,
 * off-main-thread in the image decoding thread pool, or on some combination of
 * the two.
class DecodePool : public nsIObserver

  /// Initializes the singleton instance. Should be called from the main thread.
  static void Initialize();

  /// Returns the singleton instance.
  static DecodePool* Singleton();

  /// Ask the DecodePool to run @aDecoder asynchronously and return immediately.
  void AsyncDecode(Decoder* aDecoder);

   * Run @aDecoder synchronously if the image it's decoding is small. If the
   * image is too large, or if the source data isn't complete yet, run @aDecoder
   * asynchronously instead.
  void SyncDecodeIfSmall(Decoder* aDecoder);

   * Run aDecoder synchronously if at all possible. If it can't complete
   * synchronously because the source data isn't complete, asynchronously decode
   * the rest.
  void SyncDecodeIfPossible(Decoder* aDecoder);

   * Returns an event target interface to the DecodePool's I/O thread. Callers
   * who want to deliver data to workers on the DecodePool can use this event
   * target.
   * @return An nsIEventTarget interface to the thread pool's I/O thread.
  already_AddRefed<nsIEventTarget> GetIOEventTarget();

  friend class DecodePoolWorker;

  virtual ~DecodePool();

  void Decode(Decoder* aDecoder);
  void NotifyDecodeComplete(Decoder* aDecoder);
  void NotifyProgress(Decoder* aDecoder);

  static StaticRefPtr<DecodePool> sSingleton;

  nsRefPtr<DecodePoolImpl>    mImpl;

  // mMutex protects mThreads and mIOThread.
  Mutex                     mMutex;
  nsCOMArray<nsIThread>     mThreads;
  nsCOMPtr<nsIThread>       mIOThread;

} // namespace image
} // namespace mozilla

#endif // mozilla_image_DecodePool_h