mx4j.remote

Interface HeartBeat

public interface HeartBeat

A continuous pulse from client to server that gives the information that the connection is alive and the server is up.

Version: $Revision: 1.4 $

Method Summary
int	getMaxRetries() Returns the maximum number of retries this heart beat attempts after a first connection failure before declaring the connection or the server as dead.
long	getPulsePeriod() Returns the period of time in milliseconds between two heart beats
void	start() Starts the heart beat
void	stop() Stops the heart beat

Method Detail

getMaxRetries

public int getMaxRetries()

Returns the maximum number of retries this heart beat attempts after a first connection failure before declaring the connection or the server as dead.

getPulsePeriod

public long getPulsePeriod()

Returns the period of time in milliseconds between two heart beats

start

public void start()

Starts the heart beat

Throws: IOException If there are problems contacting the server

stop

public void stop()

Stops the heart beat

Throws: IOException If there are problems contacting the server