Class VERSION

java.lang.Object
org.jgroups.stack.Protocol
org.jgroups.protocols.VERSION
All Implemented Interfaces:
Lifecycle
public class VERSION extends Protocol
Maintains a version number and adds it to all outbound messages. Inbound messages received with a different version are dropped. Mainly used by an in-place configuration change (https://redhat.atlassian.net/browse/JGRP-3043)
Since:
5.6.0
Author:
Bela Ban

  • Field Details

    • version

      protected int version

    • dropped

      protected final LongAdder dropped

  • Constructor Details

    • VERSION

      public VERSION()

  • Method Details

    • version

      public int version()

    • version

      public VERSION version(int version)

    • dropped

      public long dropped()

    • resetStats

      public void resetStats()
      Overrides:
      resetStats 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

    • down

      public CompletableFuture<Object> down(Message msg, boolean async)
      Description copied from class: Protocol
      Passes a message down asynchronously. The sending is executed in the transport's thread pool. If the pool is full and the message is marked as Message.TransientFlag.DONT_BLOCK, then it will be dropped, otherwise it will be sent on the caller's thread.
      Overrides:
      down in class Protocol
      Parameters:
      msg - The message to be sent
      async - Whether to send the message asynchronously
      Returns:
      A CompletableFuture of the result (or exception)

    • 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

    • drop

      protected void drop(int other_version, Message msg)