storage/src/mozStorageEvents.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  * vim: sw=2 ts=2 sts=2
   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 _mozStorageEvents_h_
  41 #define _mozStorageEvents_h_
  42
  43 #include "nscore.h"
  44 #include "nsTArray.h"
  45 struct sqlite3_stmt;
  46 class mozStorageConnection;
  47 class mozIStorageStatementCallback;
  48 class mozIStoragePendingStatement;
  49
  50 /**
  51  * Executes a statement in the background, and passes results back to the
  52  * caller.
  53  *
  54  * @param aStatements
  55  *        The SQLite statements to execute in the background.
  56  * @param aConnection
  57  *        The connection that created the statements to execute.
  58  * @param aCallback
  59  *        The callback that is notified of results, completion, and errors.
  60  * @param _stmt
  61  *        The handle to control the execution of the statements.
  62  */
  63 nsresult NS_executeAsync(
  64   nsTArray<sqlite3_stmt *> &aStatements,
  65   mozStorageConnection *aConnection,
  66   mozIStorageStatementCallback *aCallback,
  67   mozIStoragePendingStatement **_stmt
  68 );
  69
  70 #endif // _mozStorageEvents_h_