Package org.jgroups.protocols

Class MAKE_BATCH

java.lang.Object
org.jgroups.stack.Protocol
org.jgroups.protocols.MAKE_BATCH
All Implemented Interfaces:
Lifecycle
public class MAKE_BATCH extends Protocol
Intercepts individual up messages and creates batches from them, passing the batches up. Used by unit tests, not meant to be used in production.
Since:
3.5

  • Field Details

    • multicasts

      protected boolean multicasts

    • unicasts

      protected boolean unicasts

    • skip_oob

      protected boolean skip_oob

    • sleep_time

      protected long sleep_time

    • reg_map_mcast

      protected final Map<Address,List<Message>> reg_map_mcast

    • reg_map_ucast

      protected final Map<Address,List<Message>> reg_map_ucast

    • oob_map_mcast

      protected final Map<Address,List<Message>> oob_map_mcast

    • oob_map_ucast

      protected final Map<Address,List<Message>> oob_map_ucast

    • timer

      protected TimeScheduler timer

    • cluster_name

      protected AsciiString cluster_name

    • batcher

      protected Future<?> batcher

  • Constructor Details

    • MAKE_BATCH

      public MAKE_BATCH()

  • Method Details

    • multicasts

      public MAKE_BATCH multicasts(boolean flag)

    • unicasts

      public MAKE_BATCH unicasts(boolean flag)

    • sleepTime

      public MAKE_BATCH sleepTime(long time)

    • skipOOB

      public boolean skipOOB()

    • skipOOB

      public MAKE_BATCH skipOOB(boolean s)

    • 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

    • 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

    • 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

    • queue

      protected void queue(Message msg)

    • startBatcher

      public MAKE_BATCH startBatcher()

    • stopBatcher

      protected MAKE_BATCH stopBatcher()