storage/public/mozIStorageProgressHandler.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Storage Code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  *   Lev Serebryakov <lev@serebryakov.spb.ru>
  19  * Portions created by the Initial Developer are Copyright (C) 2007
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39
  40 interface mozIStorageConnection;
  41
  42 /**
  43  * mozIProgressHandler is to be implemented by storage consumers that
  44  * wish to receive callbacks during the request execution.
  45  */
  46 [scriptable, uuid(a3a6fcd4-bf89-4208-a837-bf2a73afd30c)]
  47 interface mozIStorageProgressHandler : nsISupports {
  48   /**
  49    * onProgress is invoked periodically during long running calls.
  50    *
  51    * @param aConnection    connection, for which progress handler is
  52    *                       invoked.
  53    *
  54    * @return true to abort request, false to continue work.
  55    */
  56
  57   boolean onProgress(in mozIStorageConnection aConnection);
  58 };