Register | Log in

Mozilla.com

  1. MDC
  2. Main Page
  3. nsICacheVisitor
Table of contents
  1. 1. Method overview
  2. 2. Methods
    1. 2.1. visitDevice()
          1. 2.1.1.1.1. Parameters
          2. 2.1.1.1.2. Return value
    2. 2.2. visitEntry()
          1. 2.2.1.1.1. Parameters
          2. 2.2.1.1.2. Return value
    3. 2.3. See also

nsICacheVisitor

Table of contents
  1. 1. Method overview
  2. 2. Methods
    1. 2.1. visitDevice()
          1. 2.1.1.1.1. Parameters
          2. 2.1.1.1.2. Return value
    2. 2.2. visitEntry()
          1. 2.2.1.1.1. Parameters
          2. 2.2.1.1.2. Return value
    3. 2.3. See also

The nsICacheVisitor interface provides information about cache devices and entries.


nsICacheVisitor is defined in netwerk/cache/public/nsICacheVisitor.idl . It is scriptable and unfrozen (hasn't changed since Mozilla 1.9) .

Inherits from: nsISupports

Method overview

boolean visitDevice(in string deviceID, in nsICacheDeviceInfo deviceInfo);
boolean visitEntry(in string deviceID, in nsICacheEntryInfo entryInfo);

Methods

visitDevice()

This method is called to provide information about a cache device. 

 boolean visitDevice(
   in string deviceID,
   in nsICacheDeviceInfo deviceInfo
 );
Parameters
deviceID
Specifies the device being visited.
deviceInfo
Specifies information about this device.
Return value

Returns true to start visiting all entries for this device, otherwise returns false to advance to the next device.

visitEntry()

This method is called to provide information about a cache entry. 

 boolean visitEntry(
   in string deviceID,
   in nsICacheEntryInfo entryInfo
 );
Parameters
deviceID
Specifies the device being visited.
entryInfo
Specifies information about this entry.
Return value

Returns true to visit the next entry on the current device, or if the end of the device has been reached, advance to the next device, otherwise returns false to advance to the next device.

Page last modified 03:10, 1 Dec 2007 by Arehman4

Tags:

Files (0)