gecko/storage/public/mozIStorageStatementCallback.idl
Shawn Wilsher f1886e9571 Bug 429986 - Provide an option for database access to be asynchronous.
This adds a method to mozIStorageStatement to allow for a statement to execute
asynchronously and report to a callback.  For writes, this can move fsyncs,
which can be painful, off of the main thread.
r=vlad
sr=shaver
2008-07-11 15:47:33 -04:00

82 lines
3.3 KiB
Plaintext

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
* vim: sw=2 ts=2 sts=2 expandtab
* ***** 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 ***** */
#include "nsISupports.idl"
interface mozIStorageResultSet;
interface mozIStorageError;
[scriptable, uuid(29383d00-d8c4-4ddd-9f8b-c2feb0f2fcfa)]
interface mozIStorageStatementCallback : nsISupports {
/**
* Called when some result is obtained from the database. This function can
* be called more than once with a different storageIResultSet each time for
* any given asynchronous statement.
*
* @param aResultSet
* The result set containing the data from the database.
*/
void handleResult(in mozIStorageResultSet aResultSet);
/**
* Called when some error occurs while executing the statement. This function
* may be called more than once with a different storageIError each time for
* any given asynchronous statement.
*
* @param aError
* An object containing information about the error.
*/
void handleError(in mozIStorageError aError);
/**
* Called when the statement has finished executing. This function will only
* be called once for any given asynchronous statement.
*
* @param aReason
* Indicates if the statement is no longer executing because it either
* finished (REASON_FINISHED), was canceled (REASON_CANCELED), or
* a fatal error occurred (REASON_ERROR).
*/
const unsigned short REASON_FINISHED = 0;
const unsigned short REASON_CANCELED = 1;
const unsigned short REASON_ERROR = 2;
void handleCompletion(in unsigned short aReason);
};