Event

sealed class Event : Serializable

Note: Event is Serializable for convenience but we currently make no guarantee that the Serialization is backward / forward compatible across LeakCanary versions, so plan accordingly. This is convenient for passing events around processes, and shouldn't be used to store them.

Types

DumpingHeap
Link copied to clipboard
class DumpingHeap(uniqueId: String) : EventListener.Event

Sent from the "LeakCanary-Heap-Dump" HandlerThread.

HeapAnalysisDone
Link copied to clipboard
sealed class HeapAnalysisDone<T : HeapAnalysis> : EventListener.Event

Sent from the thread performing the analysis.

HeapAnalysisProgress
Link copied to clipboard
class HeapAnalysisProgress(uniqueId: String, step: OnAnalysisProgressListener.Step, progressPercent: Double) : EventListener.Event

progressPercent is a value between 0..1

HeapDump
Link copied to clipboard
class HeapDump(uniqueId: String, file: File, durationMillis: Long, reason: String) : EventListener.Event

Sent from the "LeakCanary-Heap-Dump" HandlerThread.

HeapDumpFailed
Link copied to clipboard
class HeapDumpFailed(uniqueId: String, exception: Throwable, willRetryLater: Boolean) : EventListener.Event

Sent from the "LeakCanary-Heap-Dump" HandlerThread.

Properties

uniqueId
Link copied to clipboard
val uniqueId: String

Unique identifier for a related chain of event. The identifier for the events that run before HeapDump gets reset right before HeapDump is sent.

Inheritors

DumpingHeap
Link copied to clipboard
HeapDump
Link copied to clipboard
HeapDumpFailed
Link copied to clipboard
HeapAnalysisProgress
Link copied to clipboard
HeapAnalysisDone
Link copied to clipboard