1 /* ***** BEGIN LICENSE BLOCK *****
2 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3 *
4 * The contents of this file are subject to the Mozilla Public License Version
5 * 1.1 (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
7 * http://www.mozilla.org/MPL/
8 *
9 * Software distributed under the License is distributed on an "AS IS" basis,
10 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11 * for the specific language governing rights and limitations under the
12 * License.
13 *
14 * The Original Code is Mozilla.
15 *
16 * The Initial Developer of the Original Code is
17 * Netscape Communications Corporation.
18 * Portions created by the Initial Developer are Copyright (C) 2002
19 * the Initial Developer. All Rights Reserved.
20 *
21 * Contributor(s):
22 * Darin Fisher <darin@netscape.com> (original author)
23 *
24 * Alternatively, the contents of this file may be used under the terms of
25 * either the GNU General Public License Version 2 or later (the "GPL"), or
26 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 * in which case the provisions of the GPL or the LGPL are applicable instead
28 * of those above. If you wish to allow use of your version of this file only
29 * under the terms of either the GPL or the LGPL, and not to allow others to
30 * use your version of this file under the terms of the MPL, indicate your
31 * decision by deleting the provisions above and replace them with the notice
32 * and other provisions required by the GPL or the LGPL. If you do not delete
33 * the provisions above, a recipient may use your version of this file under
34 * the terms of any one of the MPL, the GPL or the LGPL.
35 *
36 * ***** END LICENSE BLOCK ***** */
37
38 #include "nsISupports.idl"
39
40 interface nsIURI;
41 interface nsIDOMNode;
42 interface nsISimpleEnumerator;
43
44 [scriptable, uuid(cba513eb-c457-4b93-832c-1a979e66edd1)]
45 interface nsIPrefetchService : nsISupports
46 {
47 /**
48 * Enqueue a request to prefetch the specified URI.
49 *
50 * @param aURI the URI of the document to prefetch
51 * @param aReferrerURI the URI of the referring page
52 * @param aSource the DOM node (such as a <link> tag) that requested this
53 * fetch, or null if the prefetch was not requested by a DOM node.
54 * @param aExplicit the link element has an explicit prefetch link type
55 */
56 void prefetchURI(in nsIURI aURI,
57 in nsIURI aReferrerURI,
58 in nsIDOMNode aSource,
59 in boolean aExplicit);
60
61 /**
62 * Enqueue a request to prefetch the specified URI, making sure it's in the
63 * offline cache.
64 *
65 * @param aURI the URI of the document to prefetch
66 * @param aReferrerURI the URI of the referring page
67 * @param aSource the DOM node (such as a <link> tag) that requested this
68 * fetch, or null if the prefetch was not requested by a DOM node.
69 * @param aExplicit the link element has an explicit offline link type
70 */
71 void prefetchURIForOfflineUse(in nsIURI aURI,
72 in nsIURI aReferrerURI,
73 in nsIDOMNode aSource,
74 in boolean aExplicit);
75
76 /**
77 * Enumerate the items in the prefetch queue. Each element in the
78 * enumeration is an nsIDOMLoadStatus.
79 *
80 * @param aIncludeNormalItems include normal prefetch items in the list.
81 * @param aIncludeOfflineItems include items being fetched for offline
82 * use.
83 */
84 nsISimpleEnumerator enumerateQueue(in boolean aIncludeNormalItems,
85 in boolean aIncludeOfflineItems);
86
87 // XXX do we need a way to cancel prefetch requests?
88 };