org.csapi.jr.se.fw.fw_application.integrity
Interface HeartBeat

All Superinterfaces:
CsapiInterface, java.io.Serializable

public interface HeartBeat
extends CsapiInterface

The Heartbeat Framework interface is used by the client application to send its heartbeat. If a Framework is capable of invoking IpAppHeartBeatMgmt.enableHeartBeat(), it shall implement IpHeartBeat and the pulse() method.


Method Summary
 void pulse()
          The client application uses this method to send its heartbeat to the framework.
 

Method Detail

pulse

public void pulse()
           throws CommonException,
                  PlatformException
The client application uses this method to send its heartbeat to the framework. The framework will be expecting a pulse at the end of every interval specified in the parameter to the IpAppHeartBeatMgmt.enableAppHeartbeat() method. If the pulse() is not received within the specified interval, then the client application can be deemed to have failed the heartbeat.

Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
PlatformException - The implementation detected an internal (for example, communication) error