mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-12-04 02:57:38 +00:00
89 lines
3.6 KiB
Plaintext
89 lines
3.6 KiB
Plaintext
/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
*
|
|
* 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 http://mozilla.org/MPL/2.0/. */
|
|
|
|
#include "nsISupports.idl"
|
|
#include "nsICache.idl"
|
|
|
|
interface nsICacheEntryDescriptor;
|
|
interface nsICacheListener;
|
|
interface nsIFile;
|
|
|
|
[scriptable, uuid(1dd7708c-de48-4ffe-b5aa-cd218c762887)]
|
|
interface nsICacheSession : nsISupports
|
|
{
|
|
/**
|
|
* Expired entries will be doomed or evicted if this attribute is set to
|
|
* true. If false, expired entries will be returned (useful for offline-
|
|
* mode and clients, such as HTTP, that can update the valid lifetime of
|
|
* cached content). This attribute defaults to true.
|
|
*/
|
|
attribute boolean doomEntriesIfExpired;
|
|
|
|
/**
|
|
* When set, entries created with this session will be placed to a cache
|
|
* based at this directory. Use when storing entries to a different
|
|
* profile than the active profile of the the current running application
|
|
* process.
|
|
*/
|
|
attribute nsIFile profileDirectory;
|
|
|
|
/**
|
|
* A cache session can only give out one descriptor with WRITE access
|
|
* to a given cache entry at a time. Until the client calls MarkValid on
|
|
* its descriptor, other attempts to open the same cache entry will block.
|
|
*/
|
|
|
|
/**
|
|
* Synchronous cache access. This method fails if it is called on the main
|
|
* thread. Use asyncOpenCacheEntry() instead. This returns a unique
|
|
* descriptor each time it is called, even if the same key is specified.
|
|
* When called by multiple threads for write access, only one writable
|
|
* descriptor will be granted. If 'blockingMode' is set to false, it will
|
|
* return NS_ERROR_CACHE_WAIT_FOR_VALIDATION rather than block when another
|
|
* descriptor has been given WRITE access but hasn't validated the entry yet.
|
|
*/
|
|
nsICacheEntryDescriptor openCacheEntry(in ACString key,
|
|
in nsCacheAccessMode accessRequested,
|
|
in boolean blockingMode);
|
|
|
|
/**
|
|
* Asynchronous cache access. Does not block the calling thread. Instead,
|
|
* the listener will be notified when the descriptor is available. If
|
|
* 'noWait' is set to true, the listener will be notified immediately with
|
|
* status NS_ERROR_CACHE_WAIT_FOR_VALIDATION rather than queuing the request
|
|
* when another descriptor has been given WRITE access but hasn't validated
|
|
* the entry yet.
|
|
*/
|
|
void asyncOpenCacheEntry(in ACString key,
|
|
in nsCacheAccessMode accessRequested,
|
|
in nsICacheListener listener,
|
|
[optional] in boolean noWait);
|
|
|
|
/**
|
|
* Evict all entries for this session's clientID according to its storagePolicy.
|
|
*/
|
|
void evictEntries();
|
|
|
|
/**
|
|
* Return whether any of the cache devices implied by the session storage policy
|
|
* are currently enabled for instantiation if they don't already exist.
|
|
*/
|
|
boolean isStorageEnabled();
|
|
|
|
/**
|
|
* Asynchronously doom an entry specified by the key. Listener will be
|
|
* notified about the status of the operation. Null may be passed if caller
|
|
* doesn't care about the result.
|
|
*/
|
|
void doomEntry(in ACString key, in nsICacheListener listener);
|
|
|
|
/**
|
|
* Private entries will be doomed when the last private browsing session
|
|
* finishes.
|
|
*/
|
|
attribute boolean isPrivate;
|
|
};
|