storage/src/mozStorageService.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   2  * vim: sw=4 ts=4 sts=4
   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 Oracle Corporation code.
  17  *
  18  * The Initial Developer of the Original Code is
  19  *  Oracle Corporation
  20  * Portions created by the Initial Developer are Copyright (C) 2004
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Vladimir Vukicevic <vladimir.vukicevic@oracle.com>
  25  *   Brett Wilson <brettw@gmail.com>
  26  *   Shawn Wilsher <me@shawnwilsher.com>
  27  *
  28  * Alternatively, the contents of this file may be used under the terms of
  29  * either the GNU General Public License Version 2 or later (the "GPL"), or
  30  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  31  * in which case the provisions of the GPL or the LGPL are applicable instead
  32  * of those above. If you wish to allow use of your version of this file only
  33  * under the terms of either the GPL or the LGPL, and not to allow others to
  34  * use your version of this file under the terms of the MPL, indicate your
  35  * decision by deleting the provisions above and replace them with the notice
  36  * and other provisions required by the GPL or the LGPL. If you do not delete
  37  * the provisions above, a recipient may use your version of this file under
  38  * the terms of any one of the MPL, the GPL or the LGPL.
  39  *
  40  * ***** END LICENSE BLOCK ***** */
  41
  42 #ifndef _MOZSTORAGESERVICE_H_
  43 #define _MOZSTORAGESERVICE_H_
  44
  45 #include "nsCOMPtr.h"
  46 #include "nsIFile.h"
  47 #include "nsIObserver.h"
  48 #include "nsIObserverService.h"
  49 #include "prlock.h"
  50
  51 #include "mozIStorageService.h"
  52 #include "mozStorageBackground.h"
  53
  54 class mozStorageConnection;
  55
  56 class mozStorageService : public mozIStorageService
  57 {
  58     friend class mozStorageConnection;
  59
  60 public:
  61     // two-phase init, must call before using service
  62     nsresult Init();
  63
  64     static mozStorageService *GetSingleton();
  65
  66     // nsISupports
  67     NS_DECL_ISUPPORTS
  68
  69     // mozIStorageService
  70     NS_DECL_MOZISTORAGESERVICE
  71
  72 private:
  73     virtual ~mozStorageService();
  74
  75     /**
  76      * Used for locking around calls when initializing connections so that we
  77      * can ensure that the state of sqlite3_enable_shared_cache is sane.
  78      */
  79     PRLock *mLock;
  80
  81     /**
  82      * The background service needs to stay around just as long as this does.
  83      */
  84     mozStorageBackground mBackground;
  85 protected:
  86     nsCOMPtr<nsIFile> mProfileStorageFile;
  87
  88     static mozStorageService *gStorageService;
  89 };
  90
  91 #endif /* _MOZSTORAGESERVICE_H_ */