storage/src/mozStorageBackground.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  * vim: sw=2 ts=2 sts=2 expandtab
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is mozilla.org code.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Mozilla Corporation.
  20  * Portions created by the Initial Developer are Copyright (C) 2008
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Shawn Wilsher <me@shawnwilsher.com> (Original Author)
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #ifndef _mozStorageBackground_h_
  41 #define _mozStorageBackground_h_
  42
  43 #include "nsClassHashtable.h"
  44 class mozStorageConnection;
  45 class nsIThreadPool;
  46 class nsIEventTarget;
  47 class nsIObserver;
  48
  49 /**
  50  * Provides an event target to dispatch background events to for storage.
  51  *
  52  * @note This class is threadsafe.
  53  */
  54 class mozStorageBackground
  55 {
  56 public:
  57
  58   /**
  59    * @returns the background event target that all events to be ran on the
  60    *          background should be dispatched to.
  61    */
  62   nsIEventTarget *target();
  63
  64   /**
  65    * Initializes this object.  Creates the background thread pool.
  66    */
  67   nsresult initialize();
  68
  69   /**
  70    * Obtains a singleton service of this class.
  71    *
  72    * @returns a mozStorageBackground object.
  73    */
  74   static mozStorageBackground *getService();
  75
  76   mozStorageBackground();
  77   ~mozStorageBackground();
  78
  79 private:
  80
  81   nsCOMPtr<nsIThreadPool> mThreadPool;
  82
  83   static mozStorageBackground *mSingleton;
  84
  85   nsCOMPtr<nsIObserver> mObserver;
  86 };
  87
  88 #endif // _mozStorageBackground_h_