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

All Superinterfaces:
CsapiInterface, java.io.Serializable

public interface HeartBeatMgmt
extends CsapiInterface

This interface allows the initialisation of a heartbeat supervision of the framework by a client application. If the IpHeartBeatMgmt interface is implemented by a Framework, as a minimum enableHeartBeat() and disableHeartBeat() shall be implemented.


Method Summary
 void changeInterval(int interval)
          Allows the administrative change of the heartbeat interval.
 void disableHeartBeat()
          Instructs the framework to cease the sending of its heartbeat.
 void enableHeartBeat(int interval, org.csapi.jr.se.fw.fw_application.integrity.AppHeartBeat appInterface)
          With this method, the client application instructs the framework to begin sending its heartbeat to the specified interface at the specified interval.
 

Method Detail

enableHeartBeat

public void enableHeartBeat(int interval,
                            org.csapi.jr.se.fw.fw_application.integrity.AppHeartBeat appInterface)
                     throws CommonException,
                            PlatformException
With this method, the client application instructs the framework to begin sending its heartbeat to the specified interface at the specified interval.

Parameters:
interval - The time interval in milliseconds between the heartbeats.
appInterface - This parameter refers to the callback interface the heartbeat is calling.
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

disableHeartBeat

public void disableHeartBeat()
                      throws CommonException,
                             PlatformException
Instructs the framework to cease the sending of its 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

changeInterval

public void changeInterval(int interval)
                    throws CommonException,
                           PlatformException
Allows the administrative change of the heartbeat interval.

Parameters:
interval - The time interval in milliseconds between the heartbeats.
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