com.eurotech.framework.watchdog

Interface WatchdogService

public interface WatchdogService

This interface provides methods for starting, stopping, and updating a hardware watchdog present on the system. Updating the watchdog, once started, prevents the system from rebooting.

Method Summary

Methods

Modifier and Type	Method and Description
void	checkin(CriticalComponent criticalService) This method is used to notify the Watchdog Service that a critical service has 'checked in' and the reboot timer should be reset.
List<CriticalComponent>	getCriticalComponents() Returns the list of the currently registered CriticalComponents
int	getHardwareTimeout() Returns the timeout value for the hardware watchdog in increments of milliseconds.
void	registerCriticalService(CriticalComponent criticalComponent) Register a critical service with the Critical Service Check-in.
void	startWatchdog() Starts the hardware watchdog on the device.
void	stopWatchdog() Stops the hardware Watchdog on the device
void	unregisterCriticalService(CriticalComponent criticalComponent) Unregister a critical service with the Critical Service Check-in.

Method Detail

startWatchdog

void startWatchdog()

Starts the hardware watchdog on the device. If a timeout value has not been set, the watchdog will use its default timeout.

stopWatchdog

void stopWatchdog()

Stops the hardware Watchdog on the device

getHardwareTimeout

int getHardwareTimeout()

Returns the timeout value for the hardware watchdog in increments of milliseconds.

Returns:

An int representing the hardware timeout value in milliseconds.

registerCriticalService

void registerCriticalService(CriticalComponent criticalComponent)

Register a critical service with the Critical Service Check-in. Once registered, the critical service must call the checkin() method (at a frequency higher than 1/timeout) to prevent a system reboot.

Parameters:

criticalService - A CriticalService to be registered.

timeout - A timeout value that the critical service cannot exceed between updates without generating a system reboot. The time is expressed in seconds.

unregisterCriticalService

void unregisterCriticalService(CriticalComponent criticalComponent)

Unregister a critical service with the Critical Service Check-in. Once unregistered, the critical service will no longer call the checkin() method.

Parameters:

criticalService - A CriticalService to be unregistered.

getCriticalComponents

List<CriticalComponent> getCriticalComponents()

Returns the list of the currently registered CriticalComponents

Returns:

A List of CriticalComponents

checkin

void checkin(CriticalComponent criticalService)

This method is used to notify the Watchdog Service that a critical service has 'checked in' and the reboot timer should be reset.

Parameters:

criticalService - A criticalService to be updated.