storage/src/mozStorageBackground.h
author Ben Hearsum <bhearsum@mozilla.com>
Wed, 23 Jul 2008 09:11:59 -0400
changeset 16136 9d9941eacb14827fdab4716710042fdde84eb60d
parent 15803 1a1e94b4dca83b4c1c968908cef6eee6ebf40cc2
child 18459 6f9dad07efcb9b94bdcf265fc72bcfbd2c322ada
permissions -rw-r--r--
bug 446660: tracking bug for build and release of Firefox 3.1a1 - version bumps for release builds (3.1a1pre -> 3.1a1) r=ted

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 * vim: sw=2 ts=2 sts=2
 * ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is
 * Mozilla Corporation. 
 * Portions created by the Initial Developer are Copyright (C) 2008
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Shawn Wilsher <me@shawnwilsher.com> (Original Author)
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#ifndef _mozStorageBackground_h_
#define _mozStorageBackground_h_

#include "nsClassHashtable.h"
class mozStorageConnection;
class nsIThreadPool;
class nsIEventTarget;
class nsIObserver;

/**
 * This class managed the connections used in the background for
 * asynchronous operations.  There is a one-to-one mapping of calling thread
 * connections to background ones.  Additionally, it manages the background
 * thread pool used for asynchronous database calls.
 *
 * @note This class is threadsafe.
 */
class mozStorageBackground
{
public:

  /**
   * @returns the background event target that all events to be ran on the
   *          background should be dispatched to.
   */
  nsIEventTarget *target();

  /**
   * Initializes this object.  Creates the background thread pool.
   */
  nsresult initialize();

  /**
   * Obtains a singleton service of this class.
   *
   * @returns a mozStorageBackground object.
   */
  static mozStorageBackground *getService();

  mozStorageBackground();
  ~mozStorageBackground();

private:

  nsCOMPtr<nsIThreadPool> mThreadPool;

  static mozStorageBackground *mSingleton;

  nsCOMPtr<nsIObserver> mObserver;
};

#endif // _mozStorageBackground_h_