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

  • Field Details

    • 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 List<Address> members

    • suspected_mbrs

      protected final Set<Address> suspected_mbrs

    • suspect_history

      protected final BoundedList<Tuple<Address,Long>> suspect_history

    • lock

      protected final Lock lock

    • timer

      protected TimeScheduler timer

    • HAS_HEADER

      protected final Predicate<Message> HAS_HEADER

    • heartbeat_sender

      protected Future<?> heartbeat_sender

    • timeout_checker

      protected Future<?> timeout_checker

    • mcast_sent

      protected final AtomicBoolean mcast_sent

  • Constructor Details

    • FailureDetection

      public FailureDetection()

  • Method Details

    • getTimestamps

      protected abstract Map<Address,?> getTimestamps()

    • getTimeoutCheckInterval

      protected abstract long getTimeoutCheckInterval()

    • getTimeoutCheckerInfo

      protected abstract 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(List<Address> mbrs)

    • createTimeoutChecker

      protected Runnable createTimeoutChecker()

    • getMembers

      public String getMembers()

    • getSuspectedMembers

      public String getSuspectedMembers()

    • isRunning

      public boolean isRunning()

    • isTimeoutCheckerRunning

      public boolean isTimeoutCheckerRunning()

    • isHeartbeatSenderRunning

      public boolean isHeartbeatSenderRunning()

    • startFailureDetection

      public void startFailureDetection()

    • stopFailureDetection

      public void stopFailureDetection()

    • printSuspectHistory

      public String printSuspectHistory()

    • resetStats

      public void resetStats()
      Overrides:
      resetStats in class Protocol

    • init

      public void init() throws 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:
      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 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 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 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(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()