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).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
DISCARD.DiscardDialog
-
Field Summary
Fields Modifier and Type Field Description protected boolean
discard_all
protected DISCARD.DiscardDialog
discard_dialog
protected double
down
protected int
drop_down_multicasts
protected int
drop_down_unicasts
protected boolean
excludeItself
protected java.util.Set<Address>
ignoredMembers
protected java.util.Collection<Address>
members
protected int
num_down
protected int
num_up
protected double
up
protected boolean
use_gui
-
Fields inherited from class org.jgroups.stack.Protocol
after_creation_hook, down_prot, ergonomics, id, local_addr, log, policies, stack, stats, up_prot
-
-
Constructor Summary
Constructors Constructor Description DISCARD()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DISCARD
addIgnoredMembers(Address... senders)
DISCARD
addIgnoreMember(Address sender)
Messages from this sender will get droppedboolean
discardAll()
DISCARD
discardAll(boolean discard_all)
java.lang.Object
down(Event evt)
An event is to be sent down the stack.java.lang.Object
down(Message msg)
A message is sent down the stack.int
dropDownMulticasts()
DISCARD
dropDownMulticasts(int drop_down_multicasts)
DISCARD
dropDownUnicasts(int drop_down_unicasts)
Drop the next N unicasts down the stackboolean
excludeItself()
DISCARD
excludeItself(boolean excludeItself)
double
getDownDiscardRate()
int
getDropDownUnicasts()
java.lang.String
getIgnoredMembers()
double
getUpDiscardRate()
DISCARD
removeIgnoredMember(Address member)
DISCARD
resetIgnoredMembers()
void
resetStats()
DISCARD
setAddress(Address localAddress)
DISCARD
setDownDiscardRate(double down)
DISCARD
setUpDiscardRate(double up)
protected boolean
shouldDropUpMessage(Message msg, Address sender)
Checks if a message should be passed up, or notvoid
start()
This method is called on aJChannel.connect(String)
; starts work.void
startGui()
void
stop()
Called on aJChannel.disconnect()
; stops work (e.g.void
stopGui()
java.lang.Object
up(Message msg)
A single message was received.void
up(MessageBatch batch)
Sends up a multiple messages in aMessageBatch
.-
Methods inherited from class org.jgroups.stack.Protocol
accept, addPolicy, addr, addr, afterCreationHook, destroy, down, enableStats, getAddress, getComponents, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getLog, getName, getPolicies, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, init, isErgonomics, level, parse, policies, providedDownServices, providedUpServices, removePolicy, requiredDownServices, requiredUpServices, resetStatistics, setDownProtocol, setErgonomics, setId, setLevel, setPolicies, setProtocolStack, setSocketFactory, setUpProtocol, setValue, statsEnabled, toString, up
-
-
-
-
Field Detail
-
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 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
-
discard_dialog
protected DISCARD.DiscardDialog discard_dialog
-
use_gui
protected boolean use_gui
-
-
Method Detail
-
getIgnoredMembers
public java.lang.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 classProtocol
-
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()
-
dropDownUnicasts
public DISCARD dropDownUnicasts(int drop_down_unicasts)
Drop the next N unicasts down the stack- Parameters:
drop_down_unicasts
-
-
dropDownMulticasts
public int dropDownMulticasts()
-
dropDownMulticasts
public DISCARD dropDownMulticasts(int drop_down_multicasts)
-
addIgnoreMember
public DISCARD addIgnoreMember(Address sender)
Messages from this sender will get dropped
-
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 aJChannel.connect(String)
; starts work. Protocols are connected ready to receive events. Will be called from bottom to top.- Specified by:
start
in interfaceLifecycle
- Overrides:
start
in classProtocol
- Throws:
java.lang.Exception
- Thrown if protocol cannot be started successfully. This will cause the ProtocolStack to fail, soJChannel.connect(String)
will throw an exception
-
stop
public void stop()
Description copied from class:Protocol
Called on aJChannel.disconnect()
; stops work (e.g. by closing multicast socket). Will be called from top to bottom.
-
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.
-
up
public void up(MessageBatch batch)
Description copied from class:Protocol
Sends up a multiple messages in aMessageBatch
. 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 (callingProtocol.accept(Message)
), and - if true - callsProtocol.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. usingMessageBatch.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.
-
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 usingdown_prot.down()
.
-
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.
-
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 classProtocol
-
-