Copy as Markdown
Other Tools
/*
* DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/netwerk/base/nsICachingChannel.idl
*/
#ifndef __gen_nsICachingChannel_h__
#define __gen_nsICachingChannel_h__
#include "nsICacheInfoChannel.h"
/* For IDL files that don't want to include root IDL files. */
#ifndef NS_NO_VTABLE
#define NS_NO_VTABLE
#endif
class nsIFile; /* forward declaration */
/* starting interface: nsICachingChannel */
#define NS_ICACHINGCHANNEL_IID_STR "dd1d6122-5ecf-4fe4-8f0f-995e7ab3121a"
#define NS_ICACHINGCHANNEL_IID \
{0xdd1d6122, 0x5ecf, 0x4fe4, \
{ 0x8f, 0x0f, 0x99, 0x5e, 0x7a, 0xb3, 0x12, 0x1a }}
class NS_NO_VTABLE nsICachingChannel : public nsICacheInfoChannel {
public:
NS_DECLARE_STATIC_IID_ACCESSOR(NS_ICACHINGCHANNEL_IID)
/* Used by ToJSValue to check which scriptable interface is implemented. */
using ScriptableInterfaceType = nsICachingChannel;
/* attribute nsISupports cacheToken; */
NS_IMETHOD GetCacheToken(nsISupports **aCacheToken) = 0;
NS_IMETHOD SetCacheToken(nsISupports *aCacheToken) = 0;
/* attribute boolean cacheOnlyMetadata; */
NS_IMETHOD GetCacheOnlyMetadata(bool *aCacheOnlyMetadata) = 0;
NS_IMETHOD SetCacheOnlyMetadata(bool aCacheOnlyMetadata) = 0;
/* attribute boolean pin; */
NS_IMETHOD GetPin(bool *aPin) = 0;
NS_IMETHOD SetPin(bool aPin) = 0;
/* void forceCacheEntryValidFor (in unsigned long aSecondsToTheFuture); */
NS_IMETHOD ForceCacheEntryValidFor(uint32_t aSecondsToTheFuture) = 0;
enum {
LOAD_NO_NETWORK_IO = 67108864U,
LOAD_BYPASS_LOCAL_CACHE = 268435456U,
LOAD_BYPASS_LOCAL_CACHE_IF_BUSY = 536870912U,
LOAD_ONLY_FROM_CACHE = 1073741824U,
LOAD_ONLY_IF_MODIFIED = 2147483648U
};
};
NS_DEFINE_STATIC_IID_ACCESSOR(nsICachingChannel, NS_ICACHINGCHANNEL_IID)
/* Use this macro when declaring classes that implement this interface. */
#define NS_DECL_NSICACHINGCHANNEL \
NS_IMETHOD GetCacheToken(nsISupports **aCacheToken) override; \
NS_IMETHOD SetCacheToken(nsISupports *aCacheToken) override; \
NS_IMETHOD GetCacheOnlyMetadata(bool *aCacheOnlyMetadata) override; \
NS_IMETHOD SetCacheOnlyMetadata(bool aCacheOnlyMetadata) override; \
NS_IMETHOD GetPin(bool *aPin) override; \
NS_IMETHOD SetPin(bool aPin) override; \
NS_IMETHOD ForceCacheEntryValidFor(uint32_t aSecondsToTheFuture) override; \
/* Use this macro when declaring the members of this interface when the
class doesn't implement the interface. This is useful for forwarding. */
#define NS_DECL_NON_VIRTUAL_NSICACHINGCHANNEL \
nsresult GetCacheToken(nsISupports **aCacheToken); \
nsresult SetCacheToken(nsISupports *aCacheToken); \
nsresult GetCacheOnlyMetadata(bool *aCacheOnlyMetadata); \
nsresult SetCacheOnlyMetadata(bool aCacheOnlyMetadata); \
nsresult GetPin(bool *aPin); \
nsresult SetPin(bool aPin); \
nsresult ForceCacheEntryValidFor(uint32_t aSecondsToTheFuture); \
/* Use this macro to declare functions that forward the behavior of this interface to another object. */
#define NS_FORWARD_NSICACHINGCHANNEL(_to) \
NS_IMETHOD GetCacheToken(nsISupports **aCacheToken) override { return _to GetCacheToken(aCacheToken); } \
NS_IMETHOD SetCacheToken(nsISupports *aCacheToken) override { return _to SetCacheToken(aCacheToken); } \
NS_IMETHOD GetCacheOnlyMetadata(bool *aCacheOnlyMetadata) override { return _to GetCacheOnlyMetadata(aCacheOnlyMetadata); } \
NS_IMETHOD SetCacheOnlyMetadata(bool aCacheOnlyMetadata) override { return _to SetCacheOnlyMetadata(aCacheOnlyMetadata); } \
NS_IMETHOD GetPin(bool *aPin) override { return _to GetPin(aPin); } \
NS_IMETHOD SetPin(bool aPin) override { return _to SetPin(aPin); } \
NS_IMETHOD ForceCacheEntryValidFor(uint32_t aSecondsToTheFuture) override { return _to ForceCacheEntryValidFor(aSecondsToTheFuture); } \
/* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
#define NS_FORWARD_SAFE_NSICACHINGCHANNEL(_to) \
NS_IMETHOD GetCacheToken(nsISupports **aCacheToken) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetCacheToken(aCacheToken); } \
NS_IMETHOD SetCacheToken(nsISupports *aCacheToken) override { return !_to ? NS_ERROR_NULL_POINTER : _to->SetCacheToken(aCacheToken); } \
NS_IMETHOD GetCacheOnlyMetadata(bool *aCacheOnlyMetadata) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetCacheOnlyMetadata(aCacheOnlyMetadata); } \
NS_IMETHOD SetCacheOnlyMetadata(bool aCacheOnlyMetadata) override { return !_to ? NS_ERROR_NULL_POINTER : _to->SetCacheOnlyMetadata(aCacheOnlyMetadata); } \
NS_IMETHOD GetPin(bool *aPin) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetPin(aPin); } \
NS_IMETHOD SetPin(bool aPin) override { return !_to ? NS_ERROR_NULL_POINTER : _to->SetPin(aPin); } \
NS_IMETHOD ForceCacheEntryValidFor(uint32_t aSecondsToTheFuture) override { return !_to ? NS_ERROR_NULL_POINTER : _to->ForceCacheEntryValidFor(aSecondsToTheFuture); } \
#endif /* __gen_nsICachingChannel_h__ */