storage/mozIStorageProgressHandler.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsISupports.idl"
   7
   8 interface mozIStorageConnection;
   9
  10 /**
  11  * mozIProgressHandler is to be implemented by storage consumers that
  12  * wish to receive callbacks during the request execution.
  13  */
  14 [scriptable, uuid(a3a6fcd4-bf89-4208-a837-bf2a73afd30c)]
  15 interface mozIStorageProgressHandler : nsISupports {
  16   /**
  17    * onProgress is invoked periodically during long running calls.
  18    *
  19    * @param aConnection    connection, for which progress handler is
  20    *                       invoked.
  21    *
  22    * @return true to abort request, false to continue work.
  23    */
  24
  25   boolean onProgress(in mozIStorageConnection aConnection);
  26 };