gecko-dev/dom/quota/nsIOfflineStorage.h
Jan Varga e9492bcd36 Bug 785884 - Implement support for temporary storage (aka shared pool). r=ehsan, r=bent
--HG--
rename : caps/tests/mochitest/test_principal_extendedorigin_appid_appstatus.html => caps/tests/mochitest/test_principal_jarprefix_origin_appid_appstatus.html
rename : dom/quota/UsageRunnable.h => dom/quota/UsageInfo.h
2013-09-11 06:18:36 +02:00

105 lines
3.3 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=2 et sw=2 tw=80: */
/* 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 nsIOfflineStorage_h__
#define nsIOfflineStorage_h__
#include "nsIFileStorage.h"
#include "mozilla/dom/quota/PersistenceType.h"
#define NS_OFFLINESTORAGE_IID \
{0xec7e878d, 0xc8c1, 0x402e, \
{ 0xa2, 0xc4, 0xf6, 0x82, 0x29, 0x4e, 0x3c, 0xb1 } }
class nsPIDOMWindow;
namespace mozilla {
namespace dom {
namespace quota {
class Client;
}
}
}
class nsIOfflineStorage : public nsIFileStorage
{
public:
typedef mozilla::dom::quota::Client Client;
typedef mozilla::dom::quota::PersistenceType PersistenceType;
NS_DECLARE_STATIC_IID_ACCESSOR(NS_OFFLINESTORAGE_IID)
NS_IMETHOD_(Client*)
GetClient() = 0;
NS_IMETHOD_(bool)
IsOwned(nsPIDOMWindow* aOwner) = 0;
NS_IMETHOD_(PersistenceType)
Type()
{
return mPersistenceType;
}
NS_IMETHOD_(const nsACString&)
Group()
{
return mGroup;
}
NS_IMETHOD_(const nsACString&)
Origin() = 0;
// Implementation of this method should close the storage (without aborting
// running operations nor discarding pending operations).
NS_IMETHOD_(nsresult)
Close() = 0;
// Whether or not the storage has had Close called on it.
NS_IMETHOD_(bool)
IsClosed() = 0;
// Implementation of this method should close the storage, all running
// operations should be aborted and pending operations should be discarded.
NS_IMETHOD_(void)
Invalidate() = 0;
protected:
nsIOfflineStorage()
: mPersistenceType(mozilla::dom::quota::PERSISTENCE_TYPE_INVALID)
{ }
virtual ~nsIOfflineStorage()
{ }
PersistenceType mPersistenceType;
nsCString mGroup;
};
NS_DEFINE_STATIC_IID_ACCESSOR(nsIOfflineStorage, NS_OFFLINESTORAGE_IID)
#define NS_DECL_NSIOFFLINESTORAGE \
NS_IMETHOD_(Client*) \
GetClient() MOZ_OVERRIDE; \
\
NS_IMETHOD_(bool) \
IsOwned(nsPIDOMWindow* aOwner) MOZ_OVERRIDE; \
\
NS_IMETHOD_(const nsACString&) \
Origin() MOZ_OVERRIDE; \
\
NS_IMETHOD_(nsresult) \
Close() MOZ_OVERRIDE; \
\
NS_IMETHOD_(bool) \
IsClosed() MOZ_OVERRIDE; \
\
NS_IMETHOD_(void) \
Invalidate() MOZ_OVERRIDE;
#endif // nsIOfflineStorage_h__