Package org.flasby.net.heartbeat

Class Heartbeater.Beat

java.lang.Object

org.flasby.net.heartbeat.Heartbeater.Beat

Enclosing class:

Heartbeater<T>

public class Heartbeater.Beat
extends Object

controls the beating of the heartbeat.

Author:

steve

Constructor Summary

Constructors

Constructor	Description
Beat(Heartbeater.Tickler<T> heartbeatSender)

Method Summary

Modifier and Type	Method	Description
void	stop()	will stop the heartbeat.
void	tickleWith(T tickleType)	called every time a message is sent which should delay the sending of the next heartbeat.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Beat

public Beat(Heartbeater.Tickler<T> heartbeatSender)

Method Details

tickleWith

public void tickleWith(T tickleType)

called every time a message is sent which should delay the sending of the next heartbeat. Does not need to be invoked when the policy is ALWAYS. In this case it will simply be ignored.

stop

public void stop()

will stop the heartbeat. If you 'tickle' the Beat then it will start beating again.