nsIZipReaderCache

Methods

init(cacheSize)

Initializes a new zip reader cache.

Parameters

cacheSize - the number of released entries to maintain before beginning to throw some out (note that the number of outstanding entries can be much greater than this number -- this is the count for those otherwise unused entries)

getZip(zipFile)

Returns a (possibly shared) nsIZipReader for an nsIFile.

If the zip reader for given file is not in the cache, a new zip reader
is created, initialized, and opened (see nsIZipReader::init and
nsIZipReader::open). Otherwise the previously created zip reader is
returned.

@note If someone called close() on the shared nsIZipReader, this method
will return the closed zip reader.

isCached(zipFile)

returns true if this zipreader already has this file cached

getInnerZip(zipFile, zipEntry)

Returns a (possibly shared) nsIZipReader for a zip inside another zip

See getZip

setMustCacheFd(zipFile, aMustCacheFd)

Whether to keep NSPR file descriptor for newly opened files in the cache.
When aMustCacheFd is enabled and a file is given, the file will be flushed
from the cache if its file descriptor was not cached.
Note: currently not supported on Windows platform.

getFd(zipFile)

Returns the cached NSPR file descriptor of the file.
Note: currently not supported on Windows platform.