startupcache/nsIStartupCache.idl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   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 Corporation startup cache code.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Mozilla Corporation
  20  * Portions created by the Initial Developer are Copyright (C) 2009
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *  Benedict Hsieh <bhsieh@mozilla.com>
  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 #include "nsIInputStream.idl"
  41 #include "nsISupports.idl"
  42 #include "nsIObserver.idl"
  43 #include "nsIObjectOutputStream.idl"
  44
  45 [uuid(de798fab-af49-4a61-8144-81550986e1da)]
  46 interface nsIStartupCache : nsISupports
  47 {
  48
  49   /** This interface is provided for testing purposes only, basically
  50    *  just to solve link vagaries. See docs in StartupCache.h
  51    *  GetBuffer, PutBuffer, and InvalidateCache act as described
  52    *  in that file. */
  53
  54   PRUint32 getBuffer(in string aID, out charPtr aBuffer);
  55   void putBuffer(in string aID, in charPtr aBuffer,
  56                             in PRUint32 aLength);
  57
  58   void invalidateCache();
  59
  60   /** In debug builds, wraps this object output stream with a stream that will
  61    *  detect and prevent the write of a multiply-referenced non-singleton object
  62    *  during serialization. In non-debug, returns an add-ref'd pointer to
  63    *  original stream, unwrapped. */
  64   nsIObjectOutputStream getDebugObjectOutputStream(in nsIObjectOutputStream aStream);
  65
  66   /* Allows clients to check whether the one-time writeout after startup
  67    * has finished yet, and also to set this variable as needed (so test
  68    * code can fire mulitple startup writes if needed).
  69    */
  70   boolean startupWriteComplete();
  71   void resetStartupWriteTimer();
  72
  73   /* Allows clients to simulate the behavior of ObserverService. */
  74   readonly attribute nsIObserver observer;
  75 };
  76