mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-04 16:15:25 +00:00
81 lines
2.9 KiB
Plaintext
81 lines
2.9 KiB
Plaintext
/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
*
|
|
* 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 nsICacheService.idl, released February 10, 2001.
|
|
*
|
|
* The Initial Developer of the Original Code is Netscape Communications
|
|
* Corporation. Portions created by Netscape are
|
|
* Copyright (C) 2001 Netscape Communications Corporation. All
|
|
* Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
* Gordon Sheridan <gordon@netscape.com>
|
|
* Patrick Beard <beard@netscape.com>
|
|
* Darin Fisher <darin@netscape.com>
|
|
*/
|
|
|
|
#include "nsISupports.idl"
|
|
#include "nsICache.idl"
|
|
|
|
interface nsISimpleEnumerator;
|
|
interface nsICacheListener;
|
|
interface nsICacheSession;
|
|
interface nsICacheVisitor;
|
|
|
|
[scriptable, uuid(0ebec4c7-742f-4f27-8e7b-7c8a0cc76348)]
|
|
interface nsICacheService : nsISupports
|
|
{
|
|
/**
|
|
* Initialize the cache service.
|
|
*/
|
|
void init();
|
|
|
|
/**
|
|
* Shutdown the cache service.
|
|
*/
|
|
void shutdown();
|
|
|
|
/**
|
|
* Create a cache session
|
|
*
|
|
* A cache session represents a client's access into the cache. The cache
|
|
* session is not "owned" by the cache service. Hence, it is possible to
|
|
* create duplicate cache sessions. Entries created by a cache session
|
|
* are invisible to other cache sessions, unless the cache sessions are
|
|
* equivalent.
|
|
*
|
|
* @param clientID - Specifies the name of the client using the cache.
|
|
* @param storagePolicy - Limits the storage policy for all entries
|
|
* accessed via the returned session. As a result, devices excluded
|
|
* by the storage policy will not be searched when opening entries
|
|
* from the returned session.
|
|
* @param streamBased - Indicates whether or not the data being cached
|
|
* can be represented as a stream. The storagePolicy must be
|
|
* consistent with the value of this field. For example, a non-stream-
|
|
* based cache entry can only have a storage policy of STORE_IN_MEMORY.
|
|
* @return new cache session.
|
|
*/
|
|
nsICacheSession createSession(in string clientID,
|
|
in nsCacheStoragePolicy storagePolicy,
|
|
in boolean streamBased);
|
|
|
|
/**
|
|
* Visit entries stored in the cache. Used to implement about:cache.
|
|
*/
|
|
void visitEntries(in nsICacheVisitor visitor);
|
|
|
|
/**
|
|
* Evicts all entries in all devices implied by the storage policy.
|
|
*/
|
|
void evictEntries(in nsCacheStoragePolicy storagePolicy);
|
|
};
|