Package org.jgroups.protocols

Class SHUFFLE

java.lang.Object
org.jgroups.stack.Protocol
org.jgroups.protocols.SHUFFLE
All Implemented Interfaces:
Lifecycle
public class SHUFFLE extends Protocol
Reorders messages by buffering them and shuffling the result after TIMEOUT ms.

  • Field Details

    • timer

      protected TimeScheduler timer

    • up_msgs

      protected List<Message> up_msgs

    • down_msgs

      protected List<Message> down_msgs

    • up_lock

      protected final Lock up_lock

    • down_lock

      protected final Lock down_lock

    • task

      protected Future<?> task

    • up

      protected volatile boolean up

    • down

      protected volatile boolean down

    • max_size

      protected int max_size

    • max_time

      protected long max_time

  • Constructor Details

    • SHUFFLE

      public SHUFFLE()

  • Method Details

    • getUpMessages

      public int getUpMessages()

    • getDownMessages

      public int getDownMessages()

    • isUp

      public boolean isUp()

    • setUp

      public SHUFFLE setUp(boolean up)

    • isDown

      public boolean isDown()

    • setDown

      public SHUFFLE setDown(boolean down)

    • getMaxSize

      public int getMaxSize()

    • setMaxSize

      public SHUFFLE setMaxSize(int max_size)

    • getMaxTime

      public long getMaxTime()

    • setMaxTime

      public SHUFFLE setMaxTime(long max_time)

    • 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

    • start

      public void start() throws Exception
      Description copied from class: Protocol
      This method is called on a JChannel.connect(String); starts work. Protocols are connected ready to receive events. Will be called from bottom to top.
      Specified by:
      start in interface Lifecycle
      Overrides:
      start in class Protocol
      Throws:
      Exception - Thrown if protocol cannot be started successfully. This will cause the ProtocolStack to fail, so JChannel.connect(String) 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

    • destroy

      public void destroy()
      Description copied from class: Protocol
      This method is called on a JChannel.close(). Does some cleanup; after the call, the VM will terminate
      Specified by:
      destroy in interface Lifecycle
      Overrides:
      destroy 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

    • flush

      public void flush(boolean stop_shuffling)

    • shuffle

      protected static void shuffle(MessageBatch batch)

    • startTask

      protected void startTask()

    • stopTask

      public void stopTask()

    • add

      protected SHUFFLE add(List<Message> queue, Message msg, Lock lock, Consumer<Message> send_function)

    • add

      protected SHUFFLE add(List<Message> queue, MessageBatch batch, Lock lock, Consumer<Message> send_function)

    • reorderAndSend

      protected SHUFFLE reorderAndSend(List<Message> list, Lock lock, Consumer<Message> send_function)