com.github.anrwatchdog

Class ANRWatchDog

java.lang.Object

java.lang.Thread

com.github.anrwatchdog.ANRWatchDog

All Implemented Interfaces:

java.lang.Runnable

public class ANRWatchDog
extends java.lang.Thread

A watchdog timer thread that detects when the UI thread has frozen.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ANRWatchDog.ANRInterceptor
static interface	ANRWatchDog.ANRListener
static interface	ANRWatchDog.InterruptionListener

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
ANRWatchDog() Constructs a watchdog that checks the ui thread every milliseconds
ANRWatchDog(int timeoutInterval) Constructs a watchdog that checks the ui thread every given interval

Method Summary

Modifier and Type	Method and Description
int	getTimeoutInterval()
void	run()
ANRWatchDog	setANRInterceptor(ANRWatchDog.ANRInterceptor interceptor) Sets an interface to intercept ANRs before they are reported.
ANRWatchDog	setANRListener(ANRWatchDog.ANRListener listener) Sets an interface for when an ANR is detected.
ANRWatchDog	setIgnoreDebugger(boolean ignoreDebugger) Set whether to ignore the debugger when detecting ANRs.
ANRWatchDog	setInterruptionListener(ANRWatchDog.InterruptionListener listener) Sets an interface for when the watchdog thread is interrupted.
ANRWatchDog	setLogThreadsWithoutStackTrace(boolean logThreadsWithoutStackTrace) Set that all running threads will be reported, even those from which no stack trace could be extracted.
ANRWatchDog	setReportAllThreads() Set that all threads will be reported (default behaviour).
ANRWatchDog	setReportMainThreadOnly() Set that only the main thread will be reported.
ANRWatchDog	setReportThreadNamePrefix(java.lang.String prefix) Set the prefix that a thread's name must have for the thread to be reported.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ANRWatchDog

public ANRWatchDog()

Constructs a watchdog that checks the ui thread every milliseconds

ANRWatchDog

public ANRWatchDog(int timeoutInterval)

Constructs a watchdog that checks the ui thread every given interval

Parameters:

timeoutInterval - The interval, in milliseconds, between to checks of the UI thread. It is therefore the maximum time the UI may freeze before being reported as ANR.

Method Detail

getTimeoutInterval

public int getTimeoutInterval()

Returns:

The interval the WatchDog

setANRListener

public ANRWatchDog setANRListener(ANRWatchDog.ANRListener listener)

Sets an interface for when an ANR is detected. If not set, the default behavior is to throw an error and crash the application.

Parameters:

listener - The new listener or null

Returns:

itself for chaining.

setANRInterceptor

public ANRWatchDog setANRInterceptor(ANRWatchDog.ANRInterceptor interceptor)

Sets an interface to intercept ANRs before they are reported. If set, you can define if, given the current duration of the detected ANR and external context, it is necessary to report the ANR.

Parameters:

interceptor - The new interceptor or null

Returns:

itself for chaining.

setInterruptionListener

public ANRWatchDog setInterruptionListener(ANRWatchDog.InterruptionListener listener)

Sets an interface for when the watchdog thread is interrupted. If not set, the default behavior is to just log the interruption message.

Parameters:

listener - The new listener or null.

Returns:

itself for chaining.

setReportThreadNamePrefix

public ANRWatchDog setReportThreadNamePrefix(java.lang.String prefix)

Set the prefix that a thread's name must have for the thread to be reported. Note that the main thread is always reported. Default "".

Parameters:

prefix - The thread name's prefix for a thread to be reported.

Returns:

itself for chaining.

setReportMainThreadOnly

public ANRWatchDog setReportMainThreadOnly()

Set that only the main thread will be reported.

Returns:

itself for chaining.

setReportAllThreads

public ANRWatchDog setReportAllThreads()

Set that all threads will be reported (default behaviour).

Returns:

itself for chaining.

setLogThreadsWithoutStackTrace

public ANRWatchDog setLogThreadsWithoutStackTrace(boolean logThreadsWithoutStackTrace)

Set that all running threads will be reported, even those from which no stack trace could be extracted. Default false.

Parameters:

logThreadsWithoutStackTrace - Whether or not all running threads should be reported

Returns:

itself for chaining.

setIgnoreDebugger

public ANRWatchDog setIgnoreDebugger(boolean ignoreDebugger)

Set whether to ignore the debugger when detecting ANRs. When ignoring the debugger, ANRWatchdog will detect ANRs even if the debugger is connected. By default, it does not, to avoid interpreting debugging pauses as ANRs. Default false.

Parameters:

ignoreDebugger - Whether to ignore the debugger.

Returns:

itself for chaining.

run

public void run()

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread