nsICacheService

IID:0ebec4c7-742f-4f27-8e7b-7c8a0cc76348
Inherits From:nsISupports

This interface is implemented by the following components:


Methods

nsICacheSession createSession ( char* clientID , nsCacheStoragePolicy storagePolicy , PRBool streamBased ) void evictEntries ( nsCacheStoragePolicy storagePolicy ) void init ( ) void shutdown ( ) void visitEntries ( nsICacheVisitor visitor )

nsICacheSession createSession ( char* clientID , nsCacheStoragePolicy storagePolicy , PRBool streamBased )

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.

Arguments:
clientID: - Specifies the name of the client using the cache.
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.
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.
Returns:
new cache session.

void evictEntries ( nsCacheStoragePolicy storagePolicy )

Evicts all entries in all devices implied by the storage policy.

Arguments:
storagePolicy

void init ( )

Initialize the cache service.


void shutdown ( )

Shutdown the cache service.


void visitEntries ( nsICacheVisitor visitor )

Visit entries stored in the cache. Used to implement about:cache.

Arguments:
visitor

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
June 5, 2005, 7:39 am trev at gtchat dot de
The methods init() and shutdown() have been removed from the interface in Gecko 1.8.

Copyright © 1999 - 2005 XULPlanet.com