summaryrefslogtreecommitdiffstats
path: root/netwerk/cache/nsCacheDevice.h
diff options
context:
space:
mode:
Diffstat (limited to 'netwerk/cache/nsCacheDevice.h')
-rw-r--r--netwerk/cache/nsCacheDevice.h63
1 files changed, 63 insertions, 0 deletions
diff --git a/netwerk/cache/nsCacheDevice.h b/netwerk/cache/nsCacheDevice.h
new file mode 100644
index 0000000000..fc68bcb8a2
--- /dev/null
+++ b/netwerk/cache/nsCacheDevice.h
@@ -0,0 +1,63 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef _nsCacheDevice_h_
+#define _nsCacheDevice_h_
+
+#include "nspr.h"
+#include "nsError.h"
+#include "nsICache.h"
+#include "nsStringFwd.h"
+
+class nsIFile;
+class nsCacheEntry;
+class nsICacheVisitor;
+class nsIInputStream;
+class nsIOutputStream;
+
+/******************************************************************************
+ * nsCacheDevice
+ *******************************************************************************/
+class nsCacheDevice {
+ public:
+ MOZ_COUNTED_DEFAULT_CTOR(nsCacheDevice)
+ MOZ_COUNTED_DTOR_VIRTUAL(nsCacheDevice)
+
+ virtual nsresult Init() = 0;
+ virtual nsresult Shutdown() = 0;
+
+ virtual const char* GetDeviceID(void) = 0;
+ virtual nsCacheEntry* FindEntry(nsCString* key, bool* collision) = 0;
+
+ virtual nsresult DeactivateEntry(nsCacheEntry* entry) = 0;
+ virtual nsresult BindEntry(nsCacheEntry* entry) = 0;
+ virtual void DoomEntry(nsCacheEntry* entry) = 0;
+
+ virtual nsresult OpenInputStreamForEntry(nsCacheEntry* entry,
+ nsCacheAccessMode mode,
+ uint32_t offset,
+ nsIInputStream** result) = 0;
+
+ virtual nsresult OpenOutputStreamForEntry(nsCacheEntry* entry,
+ nsCacheAccessMode mode,
+ uint32_t offset,
+ nsIOutputStream** result) = 0;
+
+ virtual nsresult GetFileForEntry(nsCacheEntry* entry, nsIFile** result) = 0;
+
+ virtual nsresult OnDataSizeChange(nsCacheEntry* entry, int32_t deltaSize) = 0;
+
+ virtual nsresult Visit(nsICacheVisitor* visitor) = 0;
+
+ /**
+ * Device must evict entries associated with clientID. If clientID ==
+ * nullptr, all entries must be evicted. Active entries must be doomed,
+ * rather than evicted.
+ */
+ virtual nsresult EvictEntries(const char* clientID) = 0;
+};
+
+#endif // _nsCacheDevice_h_