Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

mx4j.remote

Interface HeartBeat

Known Implementing Classes:
AbstractHeartBeat, HTTPHeartBeat, RMIHeartBeat
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 Details

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:
MX4JRemoteConstants.CONNECTION_HEARTBEAT_RETRIES, getPulsePeriod()

getPulsePeriod

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

See Also:
MX4JRemoteConstants.CONNECTION_HEARTBEAT_PERIOD, getMaxRetries()

start

public void start()
            throws IOException
Starts the heart beat

See Also:
stop()

stop

public void stop()
            throws IOException
Stops the heart beat

See Also:
start()

Overview Package Class Use Tree Index Deprecated About
Copyright © 2001-2005 The MX4J Contributors. All Rights Reserved.