Package 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
Nested Classes Modifier and Type Class Description protected static class
VERIFY_SUSPECT.Entry
static class
VERIFY_SUSPECT.VerifyHeader
-
Field Summary
Fields Modifier and Type Field Description protected java.net.InetAddress
bind_addr
protected java.net.NetworkInterface
intf
network interface to be used to send the ICMP packetsprotected Address
local_addr
protected int
num_msgs
protected boolean
running
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
after_creation_hook, down_prot, ergonomics, id, log, stack, stats, up_prot
-
-
Constructor Summary
Constructors Constructor Description VERIFY_SUSPECT()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
addSuspects(java.util.Collection<Address> list)
Adds suspected members to the suspect list.protected void
adjustSuspectedMembers(java.util.List<Address> new_mbrship)
Removes all elements from suspects that are not in the new membershipprotected void
clearSuspects()
java.lang.Object
down(Event evt)
An event is to be sent down the stack.java.lang.String
getSuspects()
long
getTimeout()
protected boolean
removeSuspect(Address suspect)
void
run()
Started when a suspected member is added to suspects.VERIFY_SUSPECT
setTimeout(long timeout)
void
start()
This method is called on aJChannel.connect(String)
.protected void
startTimer()
void
stop()
This method is called on aJChannel.disconnect()
.protected void
stopTimer()
void
unsuspect(Address mbr)
java.lang.Object
up(Event evt)
An event was received from the protocol below.java.lang.Object
up(Message msg)
A single message was received.protected void
verifySuspect(java.util.Collection<Address> mbrs)
Sends ARE_YOU_DEAD message to suspected_mbr, wait for return or timeoutprotected void
verifySuspectWithICMP(Address suspected_mbr)
-
Methods inherited from class org.jgroups.stack.Protocol
accept, afterCreationHook, destroy, down, enableStats, getConfigurableObjects, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getLog, getName, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, init, isErgonomics, level, parse, providedDownServices, providedUpServices, requiredDownServices, requiredUpServices, resetStatistics, resetStats, setDownProtocol, setErgonomics, setId, setLevel, setProtocolStack, setSocketFactory, setUpProtocol, setValue, statsEnabled, up
-
-
-
-
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
-
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
-
running
protected volatile boolean running
-
-
Method Detail
-
getSuspects
public java.lang.String getSuspects()
-
setTimeout
public VERIFY_SUSPECT setTimeout(long timeout)
-
getTimeout
public long getTimeout()
-
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 usingdown_prot.down()
.
-
up
public java.lang.Object up(Event evt)
Description copied from class:Protocol
An event was received from the protocol below. Usually the current protocol 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 usingdown_prot.down()
or c) the event (or another event) is sent up the stack usingup_prot.up()
.
-
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.
-
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 interfacejava.lang.Runnable
-
verifySuspect
protected void verifySuspect(java.util.Collection<Address> mbrs)
Sends ARE_YOU_DEAD message to suspected_mbr, wait for return or timeout
-
verifySuspectWithICMP
protected void verifySuspectWithICMP(Address suspected_mbr)
-
addSuspects
protected boolean addSuspects(java.util.Collection<Address> list)
Adds suspected members to the suspect list. Returns true if a member is not present and the timer is not running.- Parameters:
list
- The list of suspected members- Returns:
- true if the timer needs to be started, or false otherwise
-
removeSuspect
protected boolean removeSuspect(Address suspect)
-
clearSuspects
protected void clearSuspects()
-
unsuspect
public void unsuspect(Address mbr)
-
startTimer
protected void startTimer()
-
stopTimer
protected void stopTimer()
-
start
public void start() throws java.lang.Exception
Description copied from class:Protocol
This method is called on aJChannel.connect(String)
. Starts work. Protocols are connected and queues are ready to receive events. Will be called from bottom to top. This call will replace the START and START_OK events.- Overrides:
start
in classProtocol
- Throws:
java.lang.Exception
- Thrown if protocol cannot be started successfully. This will cause the ProtocolStack to fail, soJChannel.connect(String)
will throw an exception
-
stop
public void stop()
Description copied from class:Protocol
This method is called on aJChannel.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
-
-