Class UNBATCH_OOB

java.lang.Object
org.jgroups.stack.Protocol
org.jgroups.protocols.UNBATCH_OOB
All Implemented Interfaces:
Lifecycle
public class UNBATCH_OOB extends Protocol
Unbatches OOB batches when enabled and virtual threads are available.
https://issues.redhat.com/browse/JGRP-2888
Since:
5.5.0
Author:
Bela Ban

  • Field Details

    • enabled

      protected boolean enabled

    • min_size

      protected int min_size

    • num_unbatched_msgs

      protected final LongAdder num_unbatched_msgs

    • num_oob_batches

      protected final LongAdder num_oob_batches

    • thread_pool

      protected ThreadPool thread_pool

  • Constructor Details

    • UNBATCH_OOB

      public UNBATCH_OOB()

  • Method Details

    • enabled

      public boolean enabled()

    • enable

      public UNBATCH_OOB enable(boolean enable)

    • minSize

      public int minSize()

    • minSize

      public UNBATCH_OOB minSize(int min_size)

    • avgUnbatchedMessagesPerBatch

      public double avgUnbatchedMessagesPerBatch()

    • resetStats

      public void resetStats()
      Overrides:
      resetStats in class Protocol

    • 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

    • 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

    • passUp

      protected void passUp(Message msg)