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

All Superinterfaces:
CsapiInterface, java.io.Serializable

public interface FwHeartBeat
extends CsapiInterface

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


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

Method Detail

pulse

public void pulse()
           throws CommonException,
                  PlatformException
The service instance 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 IpSvcHeartBeatMgmt.enableSvcHeartbeat() method. If the pulse() is not received within the specified interval, then the service instance 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