Package org.jgroups.protocols

Class DISCARD

  • public class DISCARD
extends Protocol
    Discards up or down messages based on a percentage; e.g., setting property 'up' to 0.1 causes 10% of all up messages to be discarded. Setting 'down' or 'up' to 0 causes no loss, whereas 1 discards all messages (not very useful).

    • Field Detail

      • up

        protected double up

      • down

        protected double down

      • excludeItself

        protected boolean excludeItself

      • localAddress

        protected Address localAddress

      • num_down

        protected int num_down

      • num_up

        protected int num_up

      • ignoredMembers

        protected final java.util.Set<Address> ignoredMembers

      • members

        protected final java.util.Collection<Address> members

      • discard_all

        protected boolean discard_all

      • drop_down_unicasts

        protected int drop_down_unicasts

      • drop_down_multicasts

        protected int drop_down_multicasts

      • use_gui

        protected boolean use_gui

    • Constructor Detail

      • DISCARD

        public DISCARD()

    • Method Detail

      • getIgnoredMembers

        public java.lang.String getIgnoredMembers()

      • localAddress

        public Address localAddress()

      • isDiscardAll

        public boolean isDiscardAll()

      • setDiscardAll

        public DISCARD setDiscardAll​(boolean discard_all)

      • isExcludeItself

        public boolean isExcludeItself()

      • setLocalAddress

        public DISCARD setLocalAddress​(Address localAddress)

      • setExcludeItself

        public DISCARD setExcludeItself​(boolean excludeItself)

      • getUpDiscardRate

        public double getUpDiscardRate()

      • setUpDiscardRate

        public DISCARD setUpDiscardRate​(double up)

      • getDownDiscardRate

        public double getDownDiscardRate()

      • setDownDiscardRate

        public DISCARD setDownDiscardRate​(double down)

      • getDropDownUnicasts

        public int getDropDownUnicasts()

      • setDropDownUnicasts

        public DISCARD setDropDownUnicasts​(int drop_down_unicasts)
        Drop the next N unicasts down the stack
        Parameters:
        drop_down_unicasts -

      • getDropDownMulticasts

        public int getDropDownMulticasts()

      • setDropDownMulticasts

        public DISCARD setDropDownMulticasts​(int drop_down_multicasts)

      • addIgnoreMember

        public DISCARD addIgnoreMember​(Address sender)
        Messages from this sender will get dropped

      • addIgnoredMembers

        public DISCARD addIgnoredMembers​(Address... senders)

      • removeIgnoredMember

        public DISCARD removeIgnoredMember​(Address member)

      • resetIgnoredMembers

        public DISCARD resetIgnoredMembers()

      • startGui

        public void startGui()

      • stopGui

        public void stopGui()

      • 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

      • up

        public java.lang.Object up​(Event evt)
        Description copied from class: Protocol
        An event was received from the protocol below. Usually the current protocol will want to examine the event type and - depending on its type - perform some computation (e.g. removing headers from a MSG event type, or updating the internal membership list when receiving a VIEW_CHANGE event). Finally the event is either a) discarded, or b) an event is sent down the stack using down_prot.down() or c) the event (or another event) is sent up the stack using up_prot.up().
        Overrides:
        up 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

      • 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

      • 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

      • shouldDropUpMessage

        protected boolean shouldDropUpMessage​(Message msg,
                                      Address sender)
        Checks if a message should be passed up, or not