//leakcanary-repo/leakcanary/HeapAnalysisJob
HeapAnalysisJob¶
[androidJvm]\ interface HeapAnalysisJob
A HeapAnalysisJob represents a single prepared request to analyze the heap. It cannot be executed twice.
Types¶
| Name | Summary |
|---|---|
| Result | [androidJvm] sealed class Result |
Functions¶
| Name | Summary |
|---|---|
| cancel | [androidJvm] abstract fun cancel(cancelReason: String) Cancels the job, if possible. Jobs that are already complete cannot be canceled. |
| execute | [androidJvm] abstract fun execute(): HeapAnalysisJob.Result Starts the analysis job immediately, and blocks until a result is available. |
Properties¶
| Name | Summary |
|---|---|
| canceled | [androidJvm] abstract val canceled: Boolean true of cancel has been called or if an HeapAnalysisInterceptor has returned Result.Canceled from HeapAnalysisInterceptor.intercept. |
| context | [androidJvm] abstract val context: JobContext In memory store, mutable and thread safe. This allows passing data to interceptors. |
| executed | [androidJvm] abstract val executed: Boolean true if execute has been called. It is an error to call execute more than once. |