FD_ALL

java.lang.Object
- org.jgroups.stack.Protocol
- - org.jgroups.protocols.FD_ALL

```
public class FD_ALL
extends Protocol
```
Failure detection based on simple heartbeat protocol. Every member periodically multicasts a heartbeat. Every member also maintains a table of all members (minus itself). When data or a heartbeat from P is received, we reset the timestamp for P to the current time. Periodically, we check for expired members, and suspect those.
Reduced number of messages exchanged on suspect event: https://jira.jboss.org/browse/JGRP-1241

Author:

Bela Ban

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FD_ALL.HeartbeatHeader

Nested Classes
Modifier and Type	Class and Description
`static class`	`FD_ALL.HeartbeatHeader`

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`has_suspected_mbrs`
`protected java.util.concurrent.Future<?>`	`heartbeat_sender_future`
`protected long`	`interval`
`protected Address`	`local_addr`
`protected java.util.concurrent.locks.Lock`	`lock`
`protected java.util.List<Address>`	`members`
`protected boolean`	`msg_counts_as_heartbeat`
`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 TimeService`	`time_service`
`protected long`	`timeout`
`protected long`	`timeout_check_interval`
`protected java.util.concurrent.Future<?>`	`timeout_checker_future`
`protected TimeScheduler`	`timer`
`protected java.util.concurrent.ConcurrentMap<Address,java.lang.Long>`	`timestamps`
`protected boolean`	`use_time_service`

Fields inherited from class org.jgroups.stack.Protocol
after_creation_hook, down_prot, ergonomics, id, log, name, stack, stats, up_prot

Constructor Summary

Constructors
Constructor and Description

FD_ALL()

Constructors
Constructor and Description
`FD_ALL()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.lang.String`	`_printTimestamps()`
`protected void`	`addIfAbsent(Address mbr)`
`java.lang.Object`	`down(Event evt)` An event is to be sent down the stack.
`int`	`getHeartbeatsReceived()`
`int`	`getHeartbeatsSent()`
`long`	`getInterval()`
`java.lang.String`	`getLocalAddress()`
`java.lang.String`	`getMembers()`
`java.lang.String`	`getSuspectedMembers()`
`int`	`getSuspectEventsSent()`
`long`	`getTimeout()`
`long`	`getTimeoutCheckInterval()`
`protected long`	`getTimestamp()`
`protected void`	`handleViewChange(View v)`
`void`	`init()` Called after instance has been created (null constructor) and before protocol is started.
`protected boolean`	`isHeartbeatSenderRunning()`
`boolean`	`isRunning()`
`protected boolean`	`isTimeoutCheckerRunning()`
`java.lang.String`	`printSuspectHistory()`
`java.lang.String`	`printTimestamps()`
`void`	`resetStats()`
`void`	`setInterval(long interval)`
`void`	`setTimeout(long timeout)`
`void`	`setTimeoutCheckInterval(long timeout_check_interval)`
`void`	`startFailureDetection()`
`protected void`	`startHeartbeatSender()`
`protected void`	`startTimeoutChecker()`
`void`	`stop()` This method is called on a `Channel.disconnect()`.
`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(Event evt)` An event was received from the layer below.
`void`	`up(MessageBatch batch)` Sends up a multiple messages in a `MessageBatch`.
`protected void`	`update(Address sender)`

Methods inherited from class org.jgroups.stack.Protocol
accept, afterCreationHook, destroy, dumpStats, enableStats, getConfigurableObjects, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getLog, getName, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, isErgonomics, level, parse, printStats, providedDownServices, providedUpServices, requiredDownServices, requiredUpServices, resetStatistics, setDownProtocol, setErgonomics, setId, setLevel, setProtocolStack, setSocketFactory, setUpProtocol, setValue, setValues, start, statsEnabled

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - interval
```
protected long interval
```
  - timeout
```
protected long timeout
```
  - timeout_check_interval
```
protected long timeout_check_interval
```
  - msg_counts_as_heartbeat
```
protected boolean msg_counts_as_heartbeat
```
  - use_time_service
```
protected boolean use_time_service
```
  - num_heartbeats_sent
```
protected int num_heartbeats_sent
```
  - num_heartbeats_received
```
protected int num_heartbeats_received
```
  - num_suspect_events
```
protected int num_suspect_events
```
  - timestamps
```
protected final java.util.concurrent.ConcurrentMap<Address,java.lang.Long> timestamps
```
  - local_addr
```
protected Address local_addr
```
  - members
```
protected final java.util.List<Address> members
```
  - suspected_mbrs
```
protected final java.util.Set<Address> suspected_mbrs
```
  - has_suspected_mbrs
```
protected volatile boolean has_suspected_mbrs
```
  - timer
```
protected TimeScheduler timer
```
  - time_service
```
protected TimeService time_service
```
  - heartbeat_sender_future
```
protected java.util.concurrent.Future<?> heartbeat_sender_future
```
  - timeout_checker_future
```
protected java.util.concurrent.Future<?> timeout_checker_future
```
  - suspect_history
```
protected final BoundedList<Tuple<Address,java.lang.Long>> suspect_history
```
  - lock
```
protected final java.util.concurrent.locks.Lock lock
```
- Constructor Detail
  - FD_ALL
```
public FD_ALL()
```
- Method Detail
  - getLocalAddress
```
public java.lang.String getLocalAddress()
```
  - getMembers
```
public java.lang.String getMembers()
```
  - getSuspectedMembers
```
public java.lang.String getSuspectedMembers()
```
  - getHeartbeatsSent
```
public int getHeartbeatsSent()
```
  - getHeartbeatsReceived
```
public int getHeartbeatsReceived()
```
  - getSuspectEventsSent
```
public int getSuspectEventsSent()
```
  - getTimeout
```
public long getTimeout()
```
  - setTimeout
```
public void setTimeout(long timeout)
```
  - getTimeoutCheckInterval
```
public long getTimeoutCheckInterval()
```
  - setTimeoutCheckInterval
```
public void setTimeoutCheckInterval(long timeout_check_interval)
```
  - getInterval
```
public long getInterval()
```
  - setInterval
```
public void setInterval(long interval)
```
  - isRunning
```
public boolean isRunning()
```
  - printSuspectHistory
```
public java.lang.String printSuspectHistory()
```
  - printTimestamps
```
public java.lang.String printTimestamps()
```
  - stopFailureDetection
```
public void stopFailureDetection()
```
  - startFailureDetection
```
public void startFailureDetection()
```
  - resetStats
```
public void resetStats()
```
    Overrides:
    
    resetStats in class Protocol
  - 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
  - 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
  - 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(org.jgroups.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.getMatchingMessages(short,boolean)), 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
  - 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
  - startTimeoutChecker
```
protected void startTimeoutChecker()
```
  - stopTimeoutChecker
```
protected void stopTimeoutChecker()
```
  - startHeartbeatSender
```
protected void startHeartbeatSender()
```
  - stopHeartbeatSender
```
protected void stopHeartbeatSender()
```
  - isTimeoutCheckerRunning
```
protected boolean isTimeoutCheckerRunning()
```
  - isHeartbeatSenderRunning
```
protected boolean isHeartbeatSenderRunning()
```
  - update
```
protected void update(Address sender)
```
  - addIfAbsent
```
protected void addIfAbsent(Address mbr)
```
  - getTimestamp
```
protected long getTimestamp()
```
  - handleViewChange
```
protected void handleViewChange(View v)
```
  - _printTimestamps
```
protected java.lang.String _printTimestamps()
```
  - 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 -
    
    Returns:
    
    true if the member was removed from suspected_mbrs, otherwise false

Class FD_ALL

Nested Class Summary

Field Summary

Fields inherited from class org.jgroups.stack.Protocol

Constructor Summary

Method Summary

Methods inherited from class org.jgroups.stack.Protocol

Methods inherited from class java.lang.Object

Field Detail

interval

timeout

timeout_check_interval

msg_counts_as_heartbeat

use_time_service

num_heartbeats_sent

num_heartbeats_received

num_suspect_events

timestamps

local_addr

members

suspected_mbrs

has_suspected_mbrs

timer

time_service

heartbeat_sender_future

timeout_checker_future

suspect_history

lock

Constructor Detail

FD_ALL

Method Detail

getLocalAddress

getMembers

getSuspectedMembers

getHeartbeatsSent

getHeartbeatsReceived

getSuspectEventsSent

getTimeout

setTimeout

getTimeoutCheckInterval

setTimeoutCheckInterval

getInterval

setInterval

isRunning

printSuspectHistory

printTimestamps

stopFailureDetection

startFailureDetection

resetStats

init

stop

up

up

down

startTimeoutChecker

stopTimeoutChecker

startHeartbeatSender

stopHeartbeatSender

isTimeoutCheckerRunning

isHeartbeatSenderRunning

update

addIfAbsent

getTimestamp

handleViewChange

_printTimestamps

suspect

unsuspect