MemoryBudgetManager

class MemoryBudgetManager

This class is the client interface to memory budgets for applications and processes. A memory budget is a promise by the application or one of its processes that its memory requirements will not exceed some limit. The budget is not a hard limit: it can be exceeded but that will likely cause processes to slow down as they try to release memory and drop below the budget limit.

A budget declaration is not a request for memory from the system, nor does the declaration influence how the system allocates memory to a process. Budgets allow an application to monitor its own resource use.

There are two sets of limits on memory, in addition to the budgets managed through this interface. There are system limits and manifest budgets. Budgets managed through this interface may not exceed the system or manifest limits. Any attempt to exceed the system or manifest limits will result in an IllegalArgumentException. However, the budget set through this interface can be changed at any time, up or down, so long as the new value does not exceed the system or manifest limits.

A budget must be positive; attempting to set a budget that is zero or negative will result in an IllegalArgumentException.

A package (application) budget applies to all processes in the application, as a group. A process budget applies to a single process. It is possible to set a large budget on a process and a small budget on the package; the package budget dominates and the large process budget is irrelevant. This is not an error.

The primary interfaces provided by this class are:

• Memory Budget Configuration:
  • setPackageBudgetBytes(long) / clearPackageBudget() - Sets or clears the memory budget for the application.
  • setProcessBudgetBytes(long) / clearProcessBudget() - Sets or clears the memory budget for the calling process.
• Memory Budget Queries:
  • getPackageBudgetBytes() - Returns the current budget for the application.
  • getProcessBudgetBytes() - Returns the current budget for the calling process.
• Memory Usage Queries:
  • getPackageCurrentUsageBytes() - Returns the aggregate memory usage across all processes in the application package.
  • getProcessCurrentUsageBytes() - Returns the memory usage for the caller's specific process.
• Over-Budget Event Monitoring:
  • OnOverBudgetListener - Callback interface notified when memory usage exceeds a budget threshold.
  • registerPackageOverBudgetListener(Looper,OnOverBudgetListener) / unregisterPackageOverBudgetListener(OnOverBudgetListener) - Registers or unregisters listeners for package-level budget breaches.
  • registerProcessOverBudgetListener(Looper,OnOverBudgetListener) / unregisterProcessOverBudgetListener(OnOverBudgetListener) - Registers or unregisters listeners for process-level budget breaches.

Summary

Constants

static val LIMIT_IS_DISABLED: Long

Value: -1L

Public methods

fun clearPackageBudget(): Unit

fun clearProcessBudget(): Unit

fun getPackageBudgetBytes(): Long

fun getPackageCurrentUsageBytes(): Long

fun getProcessBudgetBytes(): Long

fun getProcessCurrentUsageBytes(): Long

fun registerPackageOverBudgetListener(
    looper: Looper?, 
    listener: MemoryBudgetManager.OnOverBudgetListener
): Unit

fun registerProcessOverBudgetListener(
    looper: Looper?, 
    listener: MemoryBudgetManager.OnOverBudgetListener
): Unit

fun setPackageBudgetBytes(budgetBytes: Long): Unit

fun setProcessBudgetBytes(budgetBytes: Long): Unit

fun unregisterPackageOverBudgetListener(listener: MemoryBudgetManager.OnOverBudgetListener): Unit

fun unregisterProcessOverBudgetListener(listener: MemoryBudgetManager.OnOverBudgetListener): Unit