storage/src/VacuumManager.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  * vim: sw=2 ts=2 et lcs=trail\:.,tab\:>~ :
   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 mozStorage.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * the Mozilla Foundation.
  20  * Portions created by the Initial Developer are Copyright (C) 2010
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Marco Bonardo <mak77@bonardo.net> (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 mozilla_storage_VacuumManager_h__
  41 #define mozilla_storage_VacuumManager_h__
  42
  43 #include "nsCOMPtr.h"
  44 #include "nsIObserver.h"
  45 #include "mozIStorageStatementCallback.h"
  46 #include "mozIStorageVacuumParticipant.h"
  47 #include "nsCategoryCache.h"
  48 #include "nsIPrefService.h"
  49
  50 namespace mozilla {
  51 namespace storage {
  52
  53 class VacuumManager : public nsIObserver
  54 {
  55 public:
  56   NS_DECL_ISUPPORTS
  57   NS_DECL_NSIOBSERVER
  58
  59   VacuumManager();
  60
  61   /**
  62    * Obtains the VacuumManager object.
  63    */
  64   static VacuumManager * getSingleton();
  65
  66   /**
  67    * Initializes the VacuumManager object.  Must be called just once.
  68    */
  69   nsresult initialize();
  70
  71 private:
  72   ~VacuumManager();
  73
  74   static VacuumManager *gVacuumManager;
  75
  76   // Cache of components registered in "vacuum-participant" category.
  77   nsCategoryCache<mozIStorageVacuumParticipant> mParticipants;
  78
  79   // Pref branch for PREF_VACUUM_BRANCH.
  80   nsCOMPtr<nsIPrefBranch> mPrefBranch;
  81 };
  82
  83 } // namespace storage
  84 } // namespace mozilla
  85
  86 #endif