DISCARD

java.lang.Object
- com.fr.third.jgroups.stack.Protocol
- - com.fr.third.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).

嵌套类概要

嵌套类
限定符和类型类和说明

protected class DISCARD.DiscardDialog

嵌套类
限定符和类型	类和说明
`protected class`	`DISCARD.DiscardDialog`

字段概要

字段
限定符和类型	字段和说明
`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 Address`	`localAddress`
`protected java.util.Collection<Address>`	`members`
`protected int`	`num_down`
`protected int`	`num_up`
`protected double`	`up`
`protected boolean`	`use_gui`

从类继承的字段 com.fr.third.jgroups.stack.Protocol
down_prot, ergonomics, id, log, name, stack, stats, up_prot

构造器概要

构造器
构造器和说明

DISCARD()

构造器
构造器和说明
`DISCARD()`

方法概要

方法
限定符和类型	方法和说明
`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.
`double`	`getDownDiscardRate()`
`int`	`getDropDownMulticasts()`
`int`	`getDropDownUnicasts()`
`double`	`getUpDiscardRate()`
`boolean`	`isDiscardAll()`
`boolean`	`isExcludeItself()`
`Address`	`localAddress()`
`DISCARD`	`localAddress(Address addr)`
`void`	`removeIgnoredMember(Address member)`
`void`	`resetIgnoredMembers()`
`void`	`resetStats()`
`void`	`setDiscardAll(boolean discard_all)`
`void`	`setDownDiscardRate(double down)`
`void`	`setDropDownMulticasts(int drop_down_multicasts)`
`void`	`setDropDownUnicasts(int drop_down_unicasts)` Drop the next N unicasts down the stack
`void`	`setExcludeItself(boolean excludeItself)`
`void`	`setLocalAddress(Address localAddress)`
`void`	`setUpDiscardRate(double up)`
`protected boolean`	`shouldDropUpMessage(Message msg, Address sender)` Checks if a message should be passed up, or not
`void`	`start()` This method is called on a `Channel.connect(String)`.
`void`	`startGui()`
`void`	`stop()` This method is called on a `Channel.disconnect()`.
`void`	`stopGui()`
`java.lang.Object`	`up(Event evt)` An event was received from the layer below.
`void`	`up(MessageBatch batch)` Sends up a multiple messages in a `MessageBatch`.

从类继承的方法 com.fr.third.jgroups.stack.Protocol
accept, destroy, dumpStats, enableStats, getConfigurableObjects, getDownProtocol, getDownServices, getId, getIdsAbove, getLevel, getName, getProtocolStack, getSocketFactory, getThreadFactory, getTransport, getUpProtocol, getUpServices, getValue, init, isErgonomics, level, parse, printStats, providedDownServices, providedUpServices, requiredDownServices, requiredUpServices, resetStatistics, setDownProtocol, setErgonomics, setId, setLevel, setProtocolStack, setSocketFactory, setUpProtocol, setValue, setValues, statsEnabled

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - 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
```
  - discard_dialog
```
protected DISCARD.DiscardDialog discard_dialog
```
  - use_gui
```
protected boolean use_gui
```
- 构造器详细资料
  - DISCARD
```
public DISCARD()
```
- 方法详细资料
  - localAddress
```
public DISCARD localAddress(Address addr)
```
  - localAddress
```
public Address localAddress()
```
  - isDiscardAll
```
public boolean isDiscardAll()
```
  - setDiscardAll
```
public void setDiscardAll(boolean discard_all)
```
  - isExcludeItself
```
public boolean isExcludeItself()
```
  - setLocalAddress
```
public void setLocalAddress(Address localAddress)
```
  - setExcludeItself
```
public void setExcludeItself(boolean excludeItself)
```
  - getUpDiscardRate
```
public double getUpDiscardRate()
```
  - setUpDiscardRate
```
public void setUpDiscardRate(double up)
```
  - getDownDiscardRate
```
public double getDownDiscardRate()
```
  - setDownDiscardRate
```
public void setDownDiscardRate(double down)
```
  - getDropDownUnicasts
```
public int getDropDownUnicasts()
```
  - setDropDownUnicasts
```
public void setDropDownUnicasts(int drop_down_unicasts)
```
    Drop the next N unicasts down the stack
    
    参数:
    drop_down_unicasts -
  - getDropDownMulticasts
```
public int getDropDownMulticasts()
```
  - setDropDownMulticasts
```
public void setDropDownMulticasts(int drop_down_multicasts)
```
  - addIgnoreMember
```
public void addIgnoreMember(Address sender)
```
    Messages from this sender will get dropped
  - removeIgnoredMember
```
public void removeIgnoredMember(Address member)
```
  - resetIgnoredMembers
```
public void resetIgnoredMembers()
```
  - startGui
```
public void startGui()
```
  - stopGui
```
public void stopGui()
```
  - start
```
public void start()
           throws java.lang.Exception
```
    从类复制的说明: 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.
    
    覆盖:
    
    start 在类中 Protocol
    
    抛出:
    
    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
  - stop
```
public void stop()
```
    从类复制的说明: Protocol
    
    This method is called on a Channel.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
    
    覆盖:
    
    stop 在类中 Protocol
  - up
```
public java.lang.Object up(Event evt)
```
    从类复制的说明: 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().
    
    覆盖:
    
    up 在类中 Protocol
  - up
```
public void up(MessageBatch batch)
```
    从类复制的说明: 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(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.
    
    覆盖:
    
    up 在类中 Protocol
    
    参数:
    batch - The message batch
  - down
```
public java.lang.Object down(Event evt)
```
    从类复制的说明: 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().
    
    覆盖:
    
    down 在类中 Protocol
  - shouldDropUpMessage
```
protected boolean shouldDropUpMessage(Message msg,
                          Address sender)
```
    Checks if a message should be passed up, or not
  - resetStats
```
public void resetStats()
```
    覆盖:
    
    resetStats 在类中 Protocol

类 DISCARD

嵌套类概要

字段概要

从类继承的字段 com.fr.third.jgroups.stack.Protocol

构造器概要

方法概要

从类继承的方法 com.fr.third.jgroups.stack.Protocol

从类继承的方法 java.lang.Object

字段详细资料

up

down

excludeItself

localAddress

num_down

num_up

ignoredMembers

members

discard_all

drop_down_unicasts

drop_down_multicasts

discard_dialog

use_gui

构造器详细资料

DISCARD

方法详细资料

localAddress

localAddress

isDiscardAll

setDiscardAll

isExcludeItself

setLocalAddress

setExcludeItself

getUpDiscardRate

setUpDiscardRate

getDownDiscardRate

setDownDiscardRate

getDropDownUnicasts

setDropDownUnicasts

getDropDownMulticasts

setDropDownMulticasts

addIgnoreMember

removeIgnoredMember

resetIgnoredMembers

startGui

stopGui

start

stop

up

up

down

shouldDropUpMessage

resetStats