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
intgetMaxRetries()
Returns the maximum number of retries this heart beat attempts after a first connection failure before declaring the connection or the server as dead.
longgetPulsePeriod()
Returns the period of time in milliseconds between two heart beats
voidstart()
Starts the heart beat
voidstop()
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.

See Also: CONNECTION_HEARTBEAT_RETRIES HeartBeat

getPulsePeriod

public long getPulsePeriod()
Returns the period of time in milliseconds between two heart beats

See Also: CONNECTION_HEARTBEAT_PERIOD HeartBeat

start

public void start()
Starts the heart beat

Throws: IOException If there are problems contacting the server

See Also: HeartBeat

stop

public void stop()
Stops the heart beat

Throws: IOException If there are problems contacting the server

See Also: HeartBeat

Copyright © 2001-2005 The MX4J Contributors. All Rights Reserved.