Back to index

lightning-sunbird  0.9+nobinonly
nsICacheVisitor.idl
Go to the documentation of this file.
00001 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
00002  *
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is nsICacheVisitor.idl, released
00017  * February 23, 2001.
00018  *
00019  * The Initial Developer of the Original Code is
00020  * Netscape Communications Corporation.
00021  * Portions created by the Initial Developer are Copyright (C) 2001
00022  * the Initial Developer. All Rights Reserved.
00023  *
00024  * Contributor(s):
00025  *   Gordon Sheridan <gordon@netscape.com>
00026  *   Patrick Beard   <beard@netscape.com>
00027  *   Darin Fisher    <darin@netscape.com>
00028  *
00029  * Alternatively, the contents of this file may be used under the terms of
00030  * either the GNU General Public License Version 2 or later (the "GPL"), or
00031  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00032  * in which case the provisions of the GPL or the LGPL are applicable instead
00033  * of those above. If you wish to allow use of your version of this file only
00034  * under the terms of either the GPL or the LGPL, and not to allow others to
00035  * use your version of this file under the terms of the MPL, indicate your
00036  * decision by deleting the provisions above and replace them with the notice
00037  * and other provisions required by the GPL or the LGPL. If you do not delete
00038  * the provisions above, a recipient may use your version of this file under
00039  * the terms of any one of the MPL, the GPL or the LGPL.
00040  *
00041  * ***** END LICENSE BLOCK ***** */
00042 
00043 #include "nsISupports.idl"
00044 
00045 /* XXX we should define device and entry info as well (stats, etc) */
00046 
00047 interface nsICacheDeviceInfo;
00048 interface nsICacheEntryInfo;
00049 
00050 
00051 [scriptable, uuid(f8c08c4b-d778-49d1-a59b-866fdc500d95)]
00052 interface nsICacheVisitor : nsISupports
00053 {
00063     boolean visitDevice(in string               deviceID,
00064                         in nsICacheDeviceInfo   deviceInfo);
00065 
00076     boolean visitEntry(in string                deviceID,
00077                        in nsICacheEntryInfo     entryInfo);
00078 };
00079 
00080 
00081 [scriptable, uuid(31d1c294-1dd2-11b2-be3a-c79230dca297)]
00082 interface nsICacheDeviceInfo : nsISupports
00083 {
00087     readonly attribute string  description;
00088     
00093     readonly attribute string  usageReport;
00094     
00098     readonly attribute unsigned long  entryCount;
00099     
00103     readonly attribute unsigned long  totalSize;
00104 
00108     readonly attribute unsigned long  maximumSize;
00109 };
00110 
00111 
00112 [scriptable, uuid(fab51c92-95c3-4468-b317-7de4d7588254)]
00113 interface nsICacheEntryInfo : nsISupports
00114 {
00118     readonly attribute string  clientID;
00119 
00123     readonly attribute string deviceID;
00124 
00128     readonly attribute ACString key;
00129     
00133     readonly attribute long  fetchCount;
00134 
00138     readonly attribute PRUint32  lastFetched;
00139 
00143     readonly attribute PRUint32  lastModified;
00144 
00148     readonly attribute PRUint32  expirationTime;
00149 
00153     readonly attribute unsigned long  dataSize;
00154 
00158     boolean  isStreamBased();
00159 };