Package org.jgroups.protocols

Class DELAY

  • All Implemented Interfaces:
    Lifecycle
    public class DELAY
extends Protocol
    Delays incoming/outgoing messages by a random number of milliseconds (range between 0 and n where n is determined by the user) and nanoseconds (constant amount).

    Incoming messages can be delayed independently from outgoing messages (or not delayed at all).

    This protocol should be inserted directly above the transport protocol (e.g. UDP).

    Author:
    Bela Ban, Sanne Grinovero, Matej Cimbora

    • Field Detail

      • in_delay

        protected int in_delay

      • out_delay

        protected int out_delay

      • in_delay_nanos

        protected int in_delay_nanos

      • out_delay_nanos

        protected int out_delay_nanos

      • constant_delay

        protected boolean constant_delay

      • delayed_message_handler

        protected org.jgroups.protocols.DELAY.DelayedMessageHandler delayed_message_handler

      • delayed_messages

        protected java.util.concurrent.DelayQueue<org.jgroups.protocols.DELAY.DelayedMessage> delayed_messages

    • Constructor Detail

      • DELAY

        public DELAY()

    • Method Detail

      • getInDelay

        public int getInDelay()

      • setInDelay

        public void setInDelay​(int in_delay)

      • getOutDelay

        public int getOutDelay()

      • setOutDelay

        public void setOutDelay​(int out_delay)

      • getInDelayNanos

        public int getInDelayNanos()

      • setInDelayNanos

        public void setInDelayNanos​(int in_delay_nanos)

      • getOutDelayNanos

        public int getOutDelayNanos()

      • setOutDelayNanos

        public void setOutDelayNanos​(int out_delay_nanos)

      • init

        public void init()
          throws java.lang.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:
        java.lang.Exception - Thrown if protocol cannot be initialized successfully. This will cause the ProtocolStack to fail, so the the channel constructor will throw an exception

      • down

        public java.lang.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 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(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