author Benjamin Smedberg <>
Tue, 01 Nov 2016 15:21:53 -0400
changeset 354883 419e1a311337ecdf208f5474f182d1f88102cc9f
parent 309110 2a3bc10a643708d268364d928c2342bb5930f8d7
child 354884 4585a7b6f3ce8c8dc7b7e043e0fae86f8e5ee392
permissions -rw-r--r--
Bug 1314378 part A - remove startupcache telemetry of dubious value. r=froydnj MozReview-Commit-ID: J1cLTvO4ecC

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at */

#include "nsIInputStream.idl"
#include "nsISupports.idl"
#include "nsIObserver.idl"
#include "nsIObjectOutputStream.idl"

#include "mozilla/UniquePtr.h"

interface nsIStartupCache : nsISupports

  /** This interface is provided for testing purposes only, basically
   *  just to solve link vagaries. See docs in StartupCache.h
   *  GetBuffer, PutBuffer, and InvalidateCache act as described 
   *  in that file. */

  uint32_t getBuffer(in string aID, out charPtr aBuffer);
  /* A more convenient interface for using from C++.  */
  nsresult GetBuffer(const char* id, mozilla::UniquePtr<char[]>* outbuf, uint32_t* length)
    char* buf;
    nsresult rv = GetBuffer(id, &buf, length);
    NS_ENSURE_SUCCESS(rv, rv);
    return rv;

  void putBuffer(in string aID, in string aBuffer, 
                            in uint32_t aLength);
  void invalidateCache();
  void ignoreDiskCache();

  /** In debug builds, wraps this object output stream with a stream that will 
   *  detect and prevent the write of a multiply-referenced non-singleton object 
   *  during serialization. In non-debug, returns an add-ref'd pointer to
   *  original stream, unwrapped. */
  nsIObjectOutputStream getDebugObjectOutputStream(in nsIObjectOutputStream aStream);

  /* Allows clients to check whether the one-time writeout after startup 
   * has finished yet, and also to set this variable as needed (so test
   * code can fire mulitple startup writes if needed).
  boolean startupWriteComplete();
  void resetStartupWriteTimer();

  /* Allows clients to simulate the behavior of ObserverService. */
  readonly attribute nsIObserver observer;