Line data Source code
1 : /*
2 : * DO NOT EDIT. THIS FILE IS GENERATED FROM ../../../dist/idl/nsICachingChannel.idl
3 : */
4 :
5 : #ifndef __gen_nsICachingChannel_h__
6 : #define __gen_nsICachingChannel_h__
7 :
8 :
9 : #ifndef __gen_nsICacheInfoChannel_h__
10 : #include "nsICacheInfoChannel.h"
11 : #endif
12 :
13 : /* For IDL files that don't want to include root IDL files. */
14 : #ifndef NS_NO_VTABLE
15 : #define NS_NO_VTABLE
16 : #endif
17 : class nsIFile; /* forward declaration */
18 :
19 :
20 : /* starting interface: nsICachingChannel */
21 : #define NS_ICACHINGCHANNEL_IID_STR "dd1d6122-5ecf-4fe4-8f0f-995e7ab3121a"
22 :
23 : #define NS_ICACHINGCHANNEL_IID \
24 : {0xdd1d6122, 0x5ecf, 0x4fe4, \
25 : { 0x8f, 0x0f, 0x99, 0x5e, 0x7a, 0xb3, 0x12, 0x1a }}
26 :
27 7 : class NS_NO_VTABLE nsICachingChannel : public nsICacheInfoChannel {
28 : public:
29 :
30 : NS_DECLARE_STATIC_IID_ACCESSOR(NS_ICACHINGCHANNEL_IID)
31 :
32 : /* attribute nsISupports cacheToken; */
33 : NS_IMETHOD GetCacheToken(nsISupports * *aCacheToken) = 0;
34 : NS_IMETHOD SetCacheToken(nsISupports *aCacheToken) = 0;
35 :
36 : /* attribute nsISupports offlineCacheToken; */
37 : NS_IMETHOD GetOfflineCacheToken(nsISupports * *aOfflineCacheToken) = 0;
38 : NS_IMETHOD SetOfflineCacheToken(nsISupports *aOfflineCacheToken) = 0;
39 :
40 : /* attribute boolean cacheOnlyMetadata; */
41 : NS_IMETHOD GetCacheOnlyMetadata(bool *aCacheOnlyMetadata) = 0;
42 : NS_IMETHOD SetCacheOnlyMetadata(bool aCacheOnlyMetadata) = 0;
43 :
44 : /* attribute boolean pin; */
45 : NS_IMETHOD GetPin(bool *aPin) = 0;
46 : NS_IMETHOD SetPin(bool aPin) = 0;
47 :
48 : /* void forceCacheEntryValidFor (in unsigned long aSecondsToTheFuture); */
49 : NS_IMETHOD ForceCacheEntryValidFor(uint32_t aSecondsToTheFuture) = 0;
50 :
51 : enum {
52 : LOAD_NO_NETWORK_IO = 67108864U,
53 : LOAD_CHECK_OFFLINE_CACHE = 134217728U,
54 : LOAD_BYPASS_LOCAL_CACHE = 268435456U,
55 : LOAD_BYPASS_LOCAL_CACHE_IF_BUSY = 536870912U,
56 : LOAD_ONLY_FROM_CACHE = 1073741824U,
57 : LOAD_ONLY_IF_MODIFIED = 2147483648U
58 : };
59 :
60 : };
61 :
62 : NS_DEFINE_STATIC_IID_ACCESSOR(nsICachingChannel, NS_ICACHINGCHANNEL_IID)
63 :
64 : /* Use this macro when declaring classes that implement this interface. */
65 : #define NS_DECL_NSICACHINGCHANNEL \
66 : NS_IMETHOD GetCacheToken(nsISupports * *aCacheToken) override; \
67 : NS_IMETHOD SetCacheToken(nsISupports *aCacheToken) override; \
68 : NS_IMETHOD GetOfflineCacheToken(nsISupports * *aOfflineCacheToken) override; \
69 : NS_IMETHOD SetOfflineCacheToken(nsISupports *aOfflineCacheToken) override; \
70 : NS_IMETHOD GetCacheOnlyMetadata(bool *aCacheOnlyMetadata) override; \
71 : NS_IMETHOD SetCacheOnlyMetadata(bool aCacheOnlyMetadata) override; \
72 : NS_IMETHOD GetPin(bool *aPin) override; \
73 : NS_IMETHOD SetPin(bool aPin) override; \
74 : NS_IMETHOD ForceCacheEntryValidFor(uint32_t aSecondsToTheFuture) override; \
75 :
76 : /* Use this macro when declaring the members of this interface when the
77 : class doesn't implement the interface. This is useful for forwarding. */
78 : #define NS_DECL_NON_VIRTUAL_NSICACHINGCHANNEL \
79 : nsresult GetCacheToken(nsISupports * *aCacheToken); \
80 : nsresult SetCacheToken(nsISupports *aCacheToken); \
81 : nsresult GetOfflineCacheToken(nsISupports * *aOfflineCacheToken); \
82 : nsresult SetOfflineCacheToken(nsISupports *aOfflineCacheToken); \
83 : nsresult GetCacheOnlyMetadata(bool *aCacheOnlyMetadata); \
84 : nsresult SetCacheOnlyMetadata(bool aCacheOnlyMetadata); \
85 : nsresult GetPin(bool *aPin); \
86 : nsresult SetPin(bool aPin); \
87 : nsresult ForceCacheEntryValidFor(uint32_t aSecondsToTheFuture); \
88 :
89 : /* Use this macro to declare functions that forward the behavior of this interface to another object. */
90 : #define NS_FORWARD_NSICACHINGCHANNEL(_to) \
91 : NS_IMETHOD GetCacheToken(nsISupports * *aCacheToken) override { return _to GetCacheToken(aCacheToken); } \
92 : NS_IMETHOD SetCacheToken(nsISupports *aCacheToken) override { return _to SetCacheToken(aCacheToken); } \
93 : NS_IMETHOD GetOfflineCacheToken(nsISupports * *aOfflineCacheToken) override { return _to GetOfflineCacheToken(aOfflineCacheToken); } \
94 : NS_IMETHOD SetOfflineCacheToken(nsISupports *aOfflineCacheToken) override { return _to SetOfflineCacheToken(aOfflineCacheToken); } \
95 : NS_IMETHOD GetCacheOnlyMetadata(bool *aCacheOnlyMetadata) override { return _to GetCacheOnlyMetadata(aCacheOnlyMetadata); } \
96 : NS_IMETHOD SetCacheOnlyMetadata(bool aCacheOnlyMetadata) override { return _to SetCacheOnlyMetadata(aCacheOnlyMetadata); } \
97 : NS_IMETHOD GetPin(bool *aPin) override { return _to GetPin(aPin); } \
98 : NS_IMETHOD SetPin(bool aPin) override { return _to SetPin(aPin); } \
99 : NS_IMETHOD ForceCacheEntryValidFor(uint32_t aSecondsToTheFuture) override { return _to ForceCacheEntryValidFor(aSecondsToTheFuture); } \
100 :
101 : /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
102 : #define NS_FORWARD_SAFE_NSICACHINGCHANNEL(_to) \
103 : NS_IMETHOD GetCacheToken(nsISupports * *aCacheToken) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetCacheToken(aCacheToken); } \
104 : NS_IMETHOD SetCacheToken(nsISupports *aCacheToken) override { return !_to ? NS_ERROR_NULL_POINTER : _to->SetCacheToken(aCacheToken); } \
105 : NS_IMETHOD GetOfflineCacheToken(nsISupports * *aOfflineCacheToken) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetOfflineCacheToken(aOfflineCacheToken); } \
106 : NS_IMETHOD SetOfflineCacheToken(nsISupports *aOfflineCacheToken) override { return !_to ? NS_ERROR_NULL_POINTER : _to->SetOfflineCacheToken(aOfflineCacheToken); } \
107 : NS_IMETHOD GetCacheOnlyMetadata(bool *aCacheOnlyMetadata) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetCacheOnlyMetadata(aCacheOnlyMetadata); } \
108 : NS_IMETHOD SetCacheOnlyMetadata(bool aCacheOnlyMetadata) override { return !_to ? NS_ERROR_NULL_POINTER : _to->SetCacheOnlyMetadata(aCacheOnlyMetadata); } \
109 : NS_IMETHOD GetPin(bool *aPin) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetPin(aPin); } \
110 : NS_IMETHOD SetPin(bool aPin) override { return !_to ? NS_ERROR_NULL_POINTER : _to->SetPin(aPin); } \
111 : NS_IMETHOD ForceCacheEntryValidFor(uint32_t aSecondsToTheFuture) override { return !_to ? NS_ERROR_NULL_POINTER : _to->ForceCacheEntryValidFor(aSecondsToTheFuture); } \
112 :
113 : #if 0
114 : /* Use the code below as a template for the implementation class for this interface. */
115 :
116 : /* Header file */
117 : class nsCachingChannel : public nsICachingChannel
118 : {
119 : public:
120 : NS_DECL_ISUPPORTS
121 : NS_DECL_NSICACHINGCHANNEL
122 :
123 : nsCachingChannel();
124 :
125 : private:
126 : ~nsCachingChannel();
127 :
128 : protected:
129 : /* additional members */
130 : };
131 :
132 : /* Implementation file */
133 : NS_IMPL_ISUPPORTS(nsCachingChannel, nsICachingChannel)
134 :
135 : nsCachingChannel::nsCachingChannel()
136 : {
137 : /* member initializers and constructor code */
138 : }
139 :
140 : nsCachingChannel::~nsCachingChannel()
141 : {
142 : /* destructor code */
143 : }
144 :
145 : /* attribute nsISupports cacheToken; */
146 : NS_IMETHODIMP nsCachingChannel::GetCacheToken(nsISupports * *aCacheToken)
147 : {
148 : return NS_ERROR_NOT_IMPLEMENTED;
149 : }
150 : NS_IMETHODIMP nsCachingChannel::SetCacheToken(nsISupports *aCacheToken)
151 : {
152 : return NS_ERROR_NOT_IMPLEMENTED;
153 : }
154 :
155 : /* attribute nsISupports offlineCacheToken; */
156 : NS_IMETHODIMP nsCachingChannel::GetOfflineCacheToken(nsISupports * *aOfflineCacheToken)
157 : {
158 : return NS_ERROR_NOT_IMPLEMENTED;
159 : }
160 : NS_IMETHODIMP nsCachingChannel::SetOfflineCacheToken(nsISupports *aOfflineCacheToken)
161 : {
162 : return NS_ERROR_NOT_IMPLEMENTED;
163 : }
164 :
165 : /* attribute boolean cacheOnlyMetadata; */
166 : NS_IMETHODIMP nsCachingChannel::GetCacheOnlyMetadata(bool *aCacheOnlyMetadata)
167 : {
168 : return NS_ERROR_NOT_IMPLEMENTED;
169 : }
170 : NS_IMETHODIMP nsCachingChannel::SetCacheOnlyMetadata(bool aCacheOnlyMetadata)
171 : {
172 : return NS_ERROR_NOT_IMPLEMENTED;
173 : }
174 :
175 : /* attribute boolean pin; */
176 : NS_IMETHODIMP nsCachingChannel::GetPin(bool *aPin)
177 : {
178 : return NS_ERROR_NOT_IMPLEMENTED;
179 : }
180 : NS_IMETHODIMP nsCachingChannel::SetPin(bool aPin)
181 : {
182 : return NS_ERROR_NOT_IMPLEMENTED;
183 : }
184 :
185 : /* void forceCacheEntryValidFor (in unsigned long aSecondsToTheFuture); */
186 : NS_IMETHODIMP nsCachingChannel::ForceCacheEntryValidFor(uint32_t aSecondsToTheFuture)
187 : {
188 : return NS_ERROR_NOT_IMPLEMENTED;
189 : }
190 :
191 : /* End of implementation class template. */
192 : #endif
193 :
194 :
195 : #endif /* __gen_nsICachingChannel_h__ */
|
