DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Untracked file

nsICachingChannel

Macros

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
/*
 * DO NOT EDIT.  THIS FILE IS GENERATED FROM ../../../dist/idl/nsICachingChannel.idl
 */

#ifndef __gen_nsICachingChannel_h__
#define __gen_nsICachingChannel_h__


#ifndef __gen_nsICacheInfoChannel_h__
#include "nsICacheInfoChannel.h"
#endif

/* 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)

  /* attribute nsISupports cacheToken; */
  NS_IMETHOD GetCacheToken(nsISupports * *aCacheToken) = 0;
  NS_IMETHOD SetCacheToken(nsISupports *aCacheToken) = 0;

  /* attribute nsISupports offlineCacheToken; */
  NS_IMETHOD GetOfflineCacheToken(nsISupports * *aOfflineCacheToken) = 0;
  NS_IMETHOD SetOfflineCacheToken(nsISupports *aOfflineCacheToken) = 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_CHECK_OFFLINE_CACHE = 134217728U,
    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 GetOfflineCacheToken(nsISupports * *aOfflineCacheToken) override; \
  NS_IMETHOD SetOfflineCacheToken(nsISupports *aOfflineCacheToken) 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 GetOfflineCacheToken(nsISupports * *aOfflineCacheToken); \
  nsresult SetOfflineCacheToken(nsISupports *aOfflineCacheToken); \
  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 GetOfflineCacheToken(nsISupports * *aOfflineCacheToken) override { return _to GetOfflineCacheToken(aOfflineCacheToken); } \
  NS_IMETHOD SetOfflineCacheToken(nsISupports *aOfflineCacheToken) override { return _to SetOfflineCacheToken(aOfflineCacheToken); } \
  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 GetOfflineCacheToken(nsISupports * *aOfflineCacheToken) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetOfflineCacheToken(aOfflineCacheToken); } \
  NS_IMETHOD SetOfflineCacheToken(nsISupports *aOfflineCacheToken) override { return !_to ? NS_ERROR_NULL_POINTER : _to->SetOfflineCacheToken(aOfflineCacheToken); } \
  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); } \

#if 0
/* Use the code below as a template for the implementation class for this interface. */

/* Header file */
class nsCachingChannel : public nsICachingChannel
{
public:
  NS_DECL_ISUPPORTS
  NS_DECL_NSICACHINGCHANNEL

  nsCachingChannel();

private:
  ~nsCachingChannel();

protected:
  /* additional members */
};

/* Implementation file */
NS_IMPL_ISUPPORTS(nsCachingChannel, nsICachingChannel)

nsCachingChannel::nsCachingChannel()
{
  /* member initializers and constructor code */
}

nsCachingChannel::~nsCachingChannel()
{
  /* destructor code */
}

/* attribute nsISupports cacheToken; */
NS_IMETHODIMP nsCachingChannel::GetCacheToken(nsISupports * *aCacheToken)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP nsCachingChannel::SetCacheToken(nsISupports *aCacheToken)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* attribute nsISupports offlineCacheToken; */
NS_IMETHODIMP nsCachingChannel::GetOfflineCacheToken(nsISupports * *aOfflineCacheToken)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP nsCachingChannel::SetOfflineCacheToken(nsISupports *aOfflineCacheToken)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* attribute boolean cacheOnlyMetadata; */
NS_IMETHODIMP nsCachingChannel::GetCacheOnlyMetadata(bool *aCacheOnlyMetadata)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP nsCachingChannel::SetCacheOnlyMetadata(bool aCacheOnlyMetadata)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* attribute boolean pin; */
NS_IMETHODIMP nsCachingChannel::GetPin(bool *aPin)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP nsCachingChannel::SetPin(bool aPin)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* void forceCacheEntryValidFor (in unsigned long aSecondsToTheFuture); */
NS_IMETHODIMP nsCachingChannel::ForceCacheEntryValidFor(uint32_t aSecondsToTheFuture)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* End of implementation class template. */
#endif


#endif /* __gen_nsICachingChannel_h__ */