leakcanary-android-release/leakcanary/HeapAnalysisJob

HeapAnalysisJob

interface HeapAnalysisJob
Content copied to clipboard

A HeapAnalysisJob represents a single prepared request to analyze the heap. It cannot be executed twice.

Types

Result
Link copied to clipboard
sealed class Result
Content copied to clipboard

Functions

cancel
Link copied to clipboard
abstract fun cancel(cancelReason: String)
Content copied to clipboard

Cancels the job, if possible. Jobs that are already complete cannot be canceled.

execute
Link copied to clipboard
abstract fun execute(): HeapAnalysisJob.Result
Content copied to clipboard

Starts the analysis job immediately, and blocks until a result is available.

Properties

canceled
Link copied to clipboard
abstract val canceled: Boolean
Content copied to clipboard

true of cancel has been called or if an HeapAnalysisInterceptor has returned Result.Canceled from HeapAnalysisInterceptor.intercept.

context
Link copied to clipboard
abstract val context: JobContext
Content copied to clipboard

In memory store, mutable and thread safe. This allows passing data to interceptors.

executed
Link copied to clipboard
abstract val executed: Boolean
Content copied to clipboard

true if execute has been called. It is an error to call execute more than once.