Package org.jgroups.protocols

Class FailureDetection

    • 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

      • local_addr

        protected Address local_addr

      • members

        protected final java.util.List<Address> members

      • suspected_mbrs

        protected final java.util.Set<Address> suspected_mbrs

      • lock

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

      • 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()

      • getInterval

        public long getInterval()

      • 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()

      • getLocalAddress

        public java.lang.String getLocalAddress()

      • 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()

      • 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 JChannel.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

      • 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(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

      • 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()