Interface nsIZipReaderCacheType

Hierarchy

Methods

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

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

    Parameters

    • zipFile: nsIFile

    Returns PRFileDescStar

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

    See getZip

    Parameters

    • zipFile: nsIFile
    • zipEntry: string

    Returns nsIZipReader

  • 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.

    Parameters

    • zipFile: nsIFile

    Returns nsIZipReader

  • Like getZip(), returns a (possibly shared) nsIZipReader for an nsIFile, but if a zip reader for the given file is not in the cache, returns error NS_ERROR_CACHE_KEY_NOT_FOUND rather than creating a new reader.

    Note

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

    Parameters

    • zipFile: nsIFile

    Returns nsIZipReader

  • Initializes a new zip reader cache.

    Parameters

    • cacheSize: number

      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)

    Returns void

  • returns true if this zipreader already has this file cached

    Parameters

    • zipFile: nsIFile

    Returns bool

Generated using TypeDoc