blob: 37c886aa91e7cf0c0f2f90001a4c5dd01b8ad0db [file] [log] [blame]
// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <stdint.h>
#include "base/time/time.h"
#include "storage/browser/quota/quota_client.h"
#include "storage/common/quota/quota_types.h"
#include "url/gurl.h"
namespace storage {
// This interface is implemented by observers that wish to monitor storage
// events, such as changes in quota or usage.
class STORAGE_EXPORT StorageObserver {
struct STORAGE_EXPORT Filter {
// The storage type to monitor. This must not be kStorageTypeUnknown or
// kStorageTypeQuotaNotManaged.
StorageType storage_type;
// The origin to monitor usage for. Must be specified.
GURL origin;
Filter(StorageType storage_type, const GURL& origin);
bool operator==(const Filter& other) const;
struct STORAGE_EXPORT MonitorParams {
// Storage type and origin to monitor.
Filter filter;
// The rate at which storage events will be fired. Events will be fired at
// approximately this rate, or when a storage status change has been
// detected, whichever is the least frequent.
base::TimeDelta rate;
// If set to true, the observer will be dispatched an event when added.
bool dispatch_initial_state;
MonitorParams(StorageType storage_type,
const GURL& origin,
const base::TimeDelta& rate,
bool get_initial_state);
MonitorParams(const Filter& filter,
const base::TimeDelta& rate,
bool get_initial_state);
struct STORAGE_EXPORT Event {
// The storage type and origin monitored.
Filter filter;
// The current usage corresponding to the filter.
int64_t usage;
// The quota corresponding to the filter.
int64_t quota;
Event(const Filter& filter, int64_t usage, int64_t quota);
bool operator==(const Event& other) const;
// Will be called on the IO thread when a storage event occurs.
virtual void OnStorageEvent(const Event& event) = 0;
virtual ~StorageObserver() {}
} // namespace storage