Package com.digi.android.watchdog

Class SystemWatchdogManager

java.lang.Object

com.digi.android.watchdog.SystemWatchdogManager

public class SystemWatchdogManager
extends java.lang.Object

This class provides access to the system watchdog service.

It allows applications to initialize and refresh the system watchdog service. If the system watchdog is not refreshed within the configured timeout, the system will reboot.

Unless noted, all system watchdog API methods require the com.digi.android.permission.WATCHDOG permission. If your application does not have this permission it will not be able to interact with the system watchdog API.

See Also:

ApplicationWatchdogManager

Field Summary

Fields

Modifier and Type	Field	Description
static long	MINIMUM_WATCHDOG_TIMEOUT	Minimum configurable timeout for the system watchdog service: milliseconds.

Constructor Summary

Constructors

Constructor	Description
SystemWatchdogManager(android.content.Context context)	Class constructor.

Method Summary

Modifier and Type	Method	Description
long	getTimeout()	Returns the configured system watchdog service timeout.
long	init(long timeout)	Initializes the system watchdog service with the given timeout (in milliseconds).
boolean	isRunning()	Returns whether the system watchdog service has been initialized or not.
void	refresh()	Refreshes the system watchdog.

Methods inherited from class java.lang.Object

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

Field Detail

MINIMUM_WATCHDOG_TIMEOUT

public static final long MINIMUM_WATCHDOG_TIMEOUT

Minimum configurable timeout for the system watchdog service: milliseconds.

See Also:

Constant Field Values

Constructor Detail

SystemWatchdogManager

public SystemWatchdogManager(android.content.Context context)

Class constructor. Instantiates a new SystemWatchdogManager using the given application context.

The SystemWatchdogManager allows your application to interact with the system watchdog service.

Parameters:

context - Android application context.

Throws:

java.lang.NullPointerException - If context == null.

Method Detail

init

public long init(long timeout)

Initializes the system watchdog service with the given timeout (in milliseconds).

This method can be called only once per device boot. Once system watchdog service is started, it can't be stopped. Any Android application can refresh the system watchdog service. If the system watchdog service is not refreshed within the configured timeout after initialization, the system will reboot.

If this method is called again when the system watchdog service is already running, an UnsupportedOperationException will be thrown.

Note the possibility that system driver may not be able to set the desired timeout. The real timeout value that is set is returned in this method after initialization. You can also use getTimeout() to read the real driver assigned watchdog timeout any time after initialization.

Parameters:

timeout - System watchdog service timeout in milliseconds (must be greater than MINIMUM_WATCHDOG_TIMEOUT).

Returns:

The timeout value that could be set in the system watchdog driver (in milliseconds).

Throws:

java.lang.IllegalArgumentException - If timeout < MINIMUM_WATCHDOG_TIMEOUT.

java.lang.UnsupportedOperationException - If system watchdog service has been already initialized.

See Also:

MINIMUM_WATCHDOG_TIMEOUT, getTimeout(), isRunning(), refresh()

getTimeout

public long getTimeout()

Returns the configured system watchdog service timeout.

This method can be called only after the system watchdog service is initialized, otherwise an UnsupportedOperationException will be thrown.

Returns:

The configured system watchdog service timeout in milliseconds.

Throws:

java.lang.UnsupportedOperationException - If the system watchdog service has not been initialized.

See Also:

init(long), isRunning(), refresh()

isRunning

public boolean isRunning()

Returns whether the system watchdog service has been initialized or not.

Returns:

true if the system watchdog service has been initialized, false otherwise.

See Also:

init(long), getTimeout(), refresh()

refresh

public void refresh()

Refreshes the system watchdog.

Throws:

java.lang.UnsupportedOperationException - If the system watchdog service has not been initialized.

See Also:

init(long), isRunning(), getTimeout()