Package org.jgroups.protocols

Class FailureDetection

java.lang.Object

org.jgroups.stack.Protocol

org.jgroups.protocols.FailureDetection

All Implemented Interfaces:

Lifecycle

Direct Known Subclasses:

FD_ALL, FD_ALL2, FD_ALL3

public abstract class FailureDetection
extends Protocol

Since:

5.0.0

Author:

Bela Ban

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FailureDetection.HeartbeatHeader

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.function.Predicate<Message>	HAS_HEADER
protected boolean	has_suspected_mbrs
protected java.util.concurrent.Future<?>	heartbeat_sender
protected long	interval
protected java.util.concurrent.locks.Lock	lock
protected java.util.concurrent.atomic.AtomicBoolean	mcast_sent
protected java.util.List<Address>	members
protected int	num_heartbeats_received
protected int	num_heartbeats_sent
protected int	num_suspect_events
protected BoundedList<Tuple<Address,java.lang.Long>>	suspect_history
protected java.util.Set<Address>	suspected_mbrs
protected long	timeout
protected java.util.concurrent.Future<?>	timeout_checker
protected TimeScheduler	timer

Fields inherited from class org.jgroups.stack.Protocol

after_creation_hook, down_prot, ergonomics, id, local_addr, log, policies, stack, stats, up_prot

Constructor Summary

Constructors

Constructor	Description
FailureDetection()

Method Summary

Modifier and Type	Method	Description
protected java.lang.Runnable	createTimeoutChecker()
java.lang.Object	down(Event evt)	An event is to be sent down the stack.
java.lang.Object	down(Message msg)	A message is sent down the stack.
int	getHeartbeatsReceived()
int	getHeartbeatsSent()
long	getInterval()
java.lang.String	getMembers()
java.lang.String	getSuspectedMembers()
int	getSuspectEventsSent()
long	getTimeout()
protected abstract java.lang.String	getTimeoutCheckerInfo()
protected abstract long	getTimeoutCheckInterval()
protected abstract java.util.Map<Address,?>	getTimestamps()
protected void	handleViewChange(View v)
void	init()	Called after a protocol has been created and before the protocol is started.
boolean	isHeartbeatSenderRunning()
boolean	isRunning()
boolean	isTimeoutCheckerRunning()
protected abstract <T> boolean	needsToBeSuspected(Address mbr, T value)
java.lang.String	printSuspectHistory()
void	resetStats()
protected void	retainKeys(java.util.List<Address> mbrs)
<T extends FailureDetection> T	setInterval(long i)
<T extends FailureDetection> T	setTimeout(long t)
void	startFailureDetection()
protected void	startHeartbeatSender()
protected void	startTimeoutChecker()
void	stop()	Called on a JChannel.disconnect(); stops work (e.g.
void	stopFailureDetection()
protected void	stopHeartbeatSender()
protected void	stopTimeoutChecker()
protected void	suspect(java.util.List<Address> suspects)
protected boolean	unsuspect(Address mbr)	Removes mbr from suspected_mbrs and sends a UNSUSPECT event up and down the stack
java.lang.Object	up(Message msg)	A single message was received.
void	up(MessageBatch batch)	Sends up a multiple messages in a MessageBatch.
protected abstract void	update(Address sender, boolean log_msg, boolean skip_if_exists)

Methods inherited from class org.jgroups.stack.Protocol

accept, addPolicy, addr, addr, afterCreationHook, destroy, down, enableStats, getAddress, getComponents, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getLog, getName, getPolicies, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, isErgonomics, level, parse, policies, providedDownServices, providedUpServices, removePolicy, requiredDownServices, requiredUpServices, resetStatistics, setAddress, setDownProtocol, setErgonomics, setId, setLevel, setPolicies, setProtocolStack, setSocketFactory, setUpProtocol, setValue, start, statsEnabled, toString, up

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

timeout

protected long timeout

interval

protected long interval

num_heartbeats_sent

protected int num_heartbeats_sent

num_heartbeats_received

protected int num_heartbeats_received

num_suspect_events

protected int num_suspect_events

has_suspected_mbrs

protected volatile boolean has_suspected_mbrs

members

protected final java.util.List<Address> members

suspected_mbrs

protected final java.util.Set<Address> suspected_mbrs

suspect_history

protected final BoundedList<Tuple<Address,java.lang.Long>> suspect_history

lock

protected final java.util.concurrent.locks.Lock lock

timer

protected TimeScheduler timer

HAS_HEADER

protected final java.util.function.Predicate<Message> HAS_HEADER

heartbeat_sender

protected java.util.concurrent.Future<?> heartbeat_sender

timeout_checker

protected java.util.concurrent.Future<?> timeout_checker

mcast_sent

protected final java.util.concurrent.atomic.AtomicBoolean mcast_sent

Constructor Detail

FailureDetection

public FailureDetection()

Method Detail

getTimestamps

protected abstract java.util.Map<Address,?> getTimestamps()

getTimeoutCheckInterval

protected abstract long getTimeoutCheckInterval()

getTimeoutCheckerInfo

protected abstract java.lang.String getTimeoutCheckerInfo()

update

protected abstract void update(Address sender,
                               boolean log_msg,
                               boolean skip_if_exists)

needsToBeSuspected

protected abstract <T> boolean needsToBeSuspected(Address mbr,
                                                  T value)

getTimeout

public long getTimeout()

setTimeout

public <T extends FailureDetection> T setTimeout(long t)

getInterval

public long getInterval()

setInterval

public <T extends FailureDetection> T setInterval(long i)

getHeartbeatsSent

public int getHeartbeatsSent()

getHeartbeatsReceived

public int getHeartbeatsReceived()

getSuspectEventsSent

public int getSuspectEventsSent()

retainKeys

protected void retainKeys(java.util.List<Address> mbrs)

createTimeoutChecker

protected java.lang.Runnable createTimeoutChecker()

getMembers

public java.lang.String getMembers()

getSuspectedMembers

public java.lang.String getSuspectedMembers()

isRunning

public boolean isRunning()

isTimeoutCheckerRunning

public boolean isTimeoutCheckerRunning()

isHeartbeatSenderRunning

public boolean isHeartbeatSenderRunning()

startFailureDetection

public void startFailureDetection()

stopFailureDetection

public void stopFailureDetection()

printSuspectHistory

public java.lang.String printSuspectHistory()

resetStats

public void resetStats()

Overrides:

resetStats in class Protocol

init

public void init()
          throws java.lang.Exception

Description copied from class: Protocol

Called after a protocol has been created and before the protocol is started. Attributes are already set. Other protocols are not yet connected and events cannot yet be sent.

Specified by:

init in interface Lifecycle

Overrides:

init in class Protocol

Throws:

java.lang.Exception - Thrown if protocol cannot be initialized successfully. This will cause the ProtocolStack to fail, so the the channel constructor will throw an exception

stop

public void stop()

Description copied from class: Protocol

Called on a JChannel.disconnect(); stops work (e.g. by closing multicast socket). Will be called from top to bottom.

Specified by:

stop in interface Lifecycle

Overrides:

stop in class Protocol

down

public java.lang.Object down(Event evt)

Description copied from class: Protocol

An event is to be sent down the stack. A protocol may want to examine its type and perform some action on it, depending on the event's type. If the event is a message MSG, then the protocol may need to add a header to it (or do nothing at all) before sending it down the stack using down_prot.down().

Overrides:

down in class Protocol

down

public java.lang.Object down(Message msg)

Description copied from class: Protocol

A message is sent down the stack. Protocols may examine the message and do something (e.g. add a header) with it, before passing it down.

Overrides:

down in class Protocol

up

public java.lang.Object up(Message msg)

Description copied from class: Protocol

A single message was received. Protocols may examine the message and do something (e.g. add a header) with it before passing it up.

Overrides:

up in class Protocol

up

public void up(MessageBatch batch)

Description copied from class: Protocol

Sends up a multiple messages in a MessageBatch. The sender of the batch is always the same, and so is the destination (null == multicast messages). Messages in a batch can be OOB messages, regular messages, or mixed messages, although the transport itself will create initial MessageBatches that contain only either OOB or regular messages.

The default processing below sends messages up the stack individually, based on a matching criteria (calling Protocol.accept(Message)), and - if true - calls Protocol.up(org.jgroups.Event) for that message and removes the message. If the batch is not empty, it is passed up, or else it is dropped.

Subclasses should check if there are any messages destined for them (e.g. using MessageBatch.iterator(Predicate)), then possibly remove and process them and finally pass the batch up to the next protocol. Protocols can also modify messages in place, e.g. ENCRYPT could decrypt all encrypted messages in the batch, not remove them, and pass the batch up when done.

Overrides:

up in class Protocol

Parameters:

batch - The message batch

handleViewChange

protected void handleViewChange(View v)

suspect

protected void suspect(java.util.List<Address> suspects)

unsuspect

protected boolean unsuspect(Address mbr)

Removes mbr from suspected_mbrs and sends a UNSUSPECT event up and down the stack

Parameters:

mbr - The member to be unsuspected

Returns:

True if the member was removed from suspected_mbrs, otherwise false

startHeartbeatSender

protected void startHeartbeatSender()

stopHeartbeatSender

protected void stopHeartbeatSender()

startTimeoutChecker

protected void startTimeoutChecker()

stopTimeoutChecker

protected void stopTimeoutChecker()