org.csapi.jr.se.fw.fw_service.integrity
Interface SvcHeartBeat

All Superinterfaces:
CsapiInterface, java.io.Serializable

public interface SvcHeartBeat
extends CsapiInterface

The service heartbeat interface is used by the framework to send the service instance its heartbeat. If a Service is capable of invoking IpFwHeartBeatMgmt.enableHeartBeat(), it shall implement IpSvcHeartBeat and the pulse() method.


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

Method Detail

pulse

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

Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.