Package org.jgroups.protocols

Class DISCARD

java.lang.Object
org.jgroups.stack.Protocol
org.jgroups.protocols.DISCARD
All Implemented Interfaces:
Lifecycle
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 Details

    • up

      protected double up

    • down

      protected double down

    • excludeItself

      protected boolean excludeItself

    • num_down

      protected int num_down

    • num_up

      protected int num_up

    • ignoredMembers

      protected final Set<Address> ignoredMembers

    • members

      protected final Collection<Address> members

    • discard_all

      protected boolean discard_all

    • discard_dialog

      protected DISCARD.DiscardDialog discard_dialog

    • use_gui

      protected boolean use_gui

  • Constructor Details

    • DISCARD

      public DISCARD()

  • Method Details

    • getIgnoredMembers

      public String getIgnoredMembers()

    • discardAll

      public boolean discardAll()

    • discardAll

      public DISCARD discardAll(boolean discard_all)

    • excludeItself

      public boolean excludeItself()

    • setAddress

      public DISCARD setAddress(Address localAddress)
      Overrides:
      setAddress in class Protocol

    • excludeItself

      public DISCARD excludeItself(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()

    • 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 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

    • 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

    • 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

    • down

      public 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

    • resetStats

      public void resetStats()
      Overrides:
      resetStats in class Protocol