org.jgroups.protocols
Class VERIFY_SUSPECT

java.lang.Object
  org.jgroups.stack.Protocol
      org.jgroups.protocols.VERIFY_SUSPECT

All Implemented Interfaces:

java.lang.Runnable

public class VERIFY_SUSPECT
extends Protocol
implements java.lang.Runnable

Catches SUSPECT events traveling up the stack. Verifies that the suspected member is really dead. If yes, passes SUSPECT event up the stack, otherwise discards it. Has to be placed somewhere above the FD layer and below the GMS layer (receiver of the SUSPECT event). Note that SUSPECT events may be reordered by this protocol.

Author:

Bela Ban

Nested Class Summary

protected class	VERIFY_SUSPECT.Entry
static class	VERIFY_SUSPECT.VerifyHeader

Field Summary

protected java.net.InetAddress	bind_addr
protected java.lang.String	bind_interface_str
protected java.net.NetworkInterface	intf network interface to be used to send the ICMP packets
protected Address	local_addr
protected int	num_msgs
protected java.util.concurrent.DelayQueue<VERIFY_SUSPECT.Entry>	suspects
protected long	timeout
protected java.lang.Thread	timer
protected boolean	use_icmp
protected boolean	use_mcast_rsps

Fields inherited from class org.jgroups.stack.Protocol

down_prot, ergonomics, id, log, name, stack, stats, up_prot

Constructor Summary

VERIFY_SUSPECT()

Method Summary

protected boolean	addSuspect(Address suspect)
protected void	adjustSuspectedMembers(java.util.List<Address> new_mbrship) Removes all elements from suspects that are not in the new membership
java.lang.Object	down(Event evt) An event is to be sent down the stack.
void	init() Called after instance has been created (null constructor) and before protocol is started.
protected boolean	removeSuspect(Address suspect)
void	run() Started when a suspected member is added to suspects.
protected void	startTimer()
void	stop() This method is called on a Channel.disconnect().
void	unsuspect(Address mbr)
java.lang.Object	up(Event evt) An event was received from the layer below.

Methods inherited from class org.jgroups.stack.Protocol

accept, destroy, dumpStats, enableStats, getConfigurableObjects, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getName, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, isErgonomics, level, printStats, providedDownServices, providedUpServices, requiredDownServices, requiredUpServices, resetStatistics, resetStats, setDownProtocol, setErgonomics, setId, setLevel, setProtocolStack, setSocketFactory, setUpProtocol, setValue, setValues, start, statsEnabled, up

Methods inherited from class java.lang.Object

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

Field Detail

timeout

protected long timeout

num_msgs

protected int num_msgs

use_icmp

protected boolean use_icmp

use_mcast_rsps

protected boolean use_mcast_rsps

bind_addr

protected java.net.InetAddress bind_addr

bind_interface_str

protected java.lang.String bind_interface_str

intf

protected java.net.NetworkInterface intf

network interface to be used to send the ICMP packets

local_addr

protected Address local_addr

suspects

protected final java.util.concurrent.DelayQueue<VERIFY_SUSPECT.Entry> suspects

timer

protected java.lang.Thread timer

Constructor Detail

VERIFY_SUSPECT

public VERIFY_SUSPECT()

Method Detail

down

public java.lang.Object down(Event evt)

Description copied from class: Protocol

An event is to be sent down the stack. The layer 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 layer may need to add a header to it (or do nothing at all) before sending it down the stack using down_prot.down(). In case of a GET_ADDRESS event (which tries to retrieve the stack's address from one of the bottom layers), the layer may need to send a new response event back up the stack using up_prot.up().

Overrides:

down in class Protocol

up

public java.lang.Object up(Event evt)

Description copied from class: Protocol

An event was received from the layer below. Usually the current layer will want to examine the event type and - depending on its type - perform some computation (e.g. removing headers from a MSG event type, or updating the internal membership list when receiving a VIEW_CHANGE event). Finally the event is either a) discarded, or b) an event is sent down the stack using down_prot.down() or c) the event (or another event) is sent up the stack using up_prot.up().

Overrides:

up in class Protocol

adjustSuspectedMembers

protected void adjustSuspectedMembers(java.util.List<Address> new_mbrship)

Removes all elements from suspects that are not in the new membership

run

public void run()

Started when a suspected member is added to suspects. Iterates over the queue as long as there are suspects in it and removes a suspect when the timeout for it has elapsed. Sends up a SUSPECT event for every removed suspect. When a suspected member is un-suspected, the member is removed from the queue.

Specified by:

run in interface java.lang.Runnable

addSuspect

protected boolean addSuspect(Address suspect)

removeSuspect

protected boolean removeSuspect(Address suspect)

unsuspect

public void unsuspect(Address mbr)

startTimer

protected void startTimer()

init

public void init()
          throws java.lang.Exception

Description copied from class: Protocol

Called after instance has been created (null constructor) and before protocol is started. Properties are already set. Other protocols are not yet connected and events cannot yet be sent.

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 channel constructor will throw an exception

stop

public void stop()

Description copied from class: Protocol

This method is called on a Channel.disconnect(). Stops work (e.g. by closing multicast socket). Will be called from top to bottom. This means that at the time of the method invocation the neighbor protocol below is still working. This method will replace the STOP, STOP_OK, CLEANUP and CLEANUP_OK events. The ProtocolStack guarantees that when this method is called all messages in the down queue will have been flushed

Overrides:

stop in class Protocol