blob: e48244b433c89729587641d8031f6f2525fa8dbf [file] [log] [blame]
// Copyright 2015 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 "base/base_export.h"
#include "base/callback.h"
#include "base/macros.h"
#include "base/memory/memory_pressure_listener.h"
namespace base {
// TODO(chrisha): Make this a concrete class with per-OS implementations rather
// than an abstract base class.
// Declares the interface for a MemoryPressureMonitor. There are multiple
// OS specific implementations of this class. An instance of the memory
// pressure observer is created at the process level, tracks memory usage, and
// pushes memory state change notifications to the static function
// base::MemoryPressureListener::NotifyMemoryPressure. This is turn notifies
// all MemoryPressureListener instances via a callback.
class BASE_EXPORT MemoryPressureMonitor {
using MemoryPressureLevel = base::MemoryPressureListener::MemoryPressureLevel;
using DispatchCallback = base::Callback<void(MemoryPressureLevel level)>;
virtual ~MemoryPressureMonitor();
// Return the singleton MemoryPressureMonitor.
static MemoryPressureMonitor* Get();
// Record memory pressure UMA statistic. A tick is 5 seconds.
static void RecordMemoryPressure(MemoryPressureLevel level, int ticks);
// Returns the currently observed memory pressure.
virtual MemoryPressureLevel GetCurrentPressureLevel() = 0;
// Sets a notification callback. The default callback invokes
// base::MemoryPressureListener::NotifyMemoryPressure.
virtual void SetDispatchCallback(const DispatchCallback& callback) = 0;
} // namespace base