org.jgroups.protocols
Class DISCARD

java.lang.Object
  org.jgroups.stack.Protocol
      org.jgroups.protocols.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).

Nested Class Summary

static class

DISCARD.DiscardHeader

Field Summary

Fields inherited from class org.jgroups.stack.Protocol

down_prot, log, props, stack, stats, up_prot

Constructor Summary

DISCARD()

Method Summary

void	addIgnoreMember(Address sender) Messages from this sender will get dropped
java.lang.Object	down(Event evt) An event is to be sent down the stack.
java.util.Map<java.lang.String,java.lang.Object>	dumpStats()
java.lang.String	getName() All protocol names have to be unique !
boolean	isDiscardAll()
void	resetIgnoredMembers()
void	resetStats()
void	setDiscardAll(boolean discard_all)
boolean	setProperties(java.util.Properties props) Configures the protocol initially.
void	start() This method is called on a Channel.connect(String).
java.lang.Object	up(Event evt) An event was received from the layer below.

Methods inherited from class org.jgroups.stack.Protocol

destroy, downThreadEnabled, enableStats, getDownProtocol, getProperties, getProtocolStack, getUpProtocol, init, printStats, providedDownServices, providedUpServices, requiredDownServices, requiredUpServices, setDownProtocol, setPropertiesInternal, setProtocolStack, setUpProtocol, statsEnabled, stop, upThreadEnabled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DISCARD

public DISCARD()

Method Detail

getName

public java.lang.String getName()

All protocol names have to be unique !

Specified by:

getName in class Protocol

isDiscardAll

public boolean isDiscardAll()

setDiscardAll

public void setDiscardAll(boolean discard_all)

setProperties

public boolean setProperties(java.util.Properties props)

Description copied from class: Protocol

Configures the protocol initially. A configuration string consists of name=value items, separated by a ';' (semicolon), e.g.:

 "loopback=false;unicast_inport=4444"
 

Overrides:

setProperties in class Protocol

addIgnoreMember

public void addIgnoreMember(Address sender)

Messages from this sender will get dropped

resetIgnoredMembers

public void resetIgnoredMembers()

start

public void start()
           throws java.lang.Exception

Description copied from class: Protocol

This method is called on a Channel.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 Channel.connect(String) will throw an exception

up

public java.lang.Object up(Event evt)

Description copied from class: Protocol

An event was received from the layer below. Usually the current layer 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

down

public java.lang.Object down(Event evt)

Description copied from class: Protocol

An event is to be sent down the stack. The layer 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 layer may need to add a header to it (or do nothing at all) before sending it down the stack using down_prot.down(). In case of a GET_ADDRESS event (which tries to retrieve the stack's address from one of the bottom layers), the layer may need to send a new response event back up the stack using up_prot.up().

Overrides:

down in class Protocol

resetStats

public void resetStats()

Overrides:

resetStats in class Protocol

dumpStats

public java.util.Map<java.lang.String,java.lang.Object> dumpStats()

Overrides:

dumpStats in class Protocol