org.eclipse.kura.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 criticalComponent) 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	registerCriticalComponent(CriticalComponent criticalComponent) Register a critical component with the WatchdogService Check-in.
void	registerCriticalService(CriticalComponent criticalComponent) Deprecated.
void	startWatchdog() Deprecated.
void	stopWatchdog() Deprecated.
void	unregisterCriticalComponent(CriticalComponent criticalComponent) Unregister a critical component with the WatchdogService Check-in.
void	unregisterCriticalService(CriticalComponent criticalComponent) Deprecated.

Method Detail

startWatchdog

@Deprecated
void startWatchdog()

Deprecated.

Starts the hardware watchdog on the device. If a timeout value has not been set, the watchdog will use its default timeout.
This call is no longer used. The life-cycle of the watchdog is controlled by the configuration parameters of the WatchdogSerivce. The API call is retained for compatibility reasons.

stopWatchdog

@Deprecated
void stopWatchdog()

Deprecated.

Stops the hardware Watchdog on the device This call is no longer used. The life-cycle of the watchdog is controlled by the configuration parameters of the WatchdogSerivce. The API call is retained for compatibility reasons.

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

@Deprecated
void registerCriticalService(CriticalComponent criticalComponent)

Deprecated.

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

@Deprecated
void unregisterCriticalService(CriticalComponent criticalComponent)

Deprecated.

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.

registerCriticalComponent

void registerCriticalComponent(CriticalComponent criticalComponent)

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

Parameters:

CriticalComponent - The CriticalComponent 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.

unregisterCriticalComponent

void unregisterCriticalComponent(CriticalComponent criticalComponent)

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

Parameters:

CriticalComponent - The CriticalComponent to be unregistered.

getCriticalComponents

List<CriticalComponent> getCriticalComponents()

Returns the list of the currently registered CriticalComponents

Returns:

A List of CriticalComponents

checkin

void checkin(CriticalComponent criticalComponent)

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

Parameters:

criticalComponent - The criticalComponent to be updated.