Package org.jgroups.protocols

Class MAKE_BATCH

  • 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
    Author:
    Bela Ban

    • Field Detail

      • multicasts

        protected boolean multicasts

      • unicasts

        protected boolean unicasts

      • sleep_time

        protected long sleep_time

      • reg_map_mcast

        protected final java.util.Map<Address,​java.util.List<Message>> reg_map_mcast

      • reg_map_ucast

        protected final java.util.Map<Address,​java.util.List<Message>> reg_map_ucast

      • oob_map_mcast

        protected final java.util.Map<Address,​java.util.List<Message>> oob_map_mcast

      • oob_map_ucast

        protected final java.util.Map<Address,​java.util.List<Message>> oob_map_ucast

      • local_addr

        protected Address local_addr

      • batcher

        protected java.util.concurrent.Future<?> batcher

    • Constructor Detail

      • MAKE_BATCH

        public MAKE_BATCH()

    • Method Detail

      • multicasts

        public MAKE_BATCH multicasts​(boolean flag)

      • unicasts

        public MAKE_BATCH unicasts​(boolean flag)

      • sleepTime

        public MAKE_BATCH sleepTime​(long time)

      • start

        public void start()
           throws java.lang.Exception
        Description copied from class: Protocol
        This method is called on a JChannel.connect(String). Starts work. Protocols are connected and queues are ready to receive events. Will be called from bottom to top. This call will replace the START and START_OK events.
        Overrides:
        start in class Protocol
        Throws:
        java.lang.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
        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

      • 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

      • queue

        protected void queue​(Message msg)

      • startBatcher

        public void startBatcher()

      • stopBatcher

        protected void stopBatcher()