RATE_LIMITER

java.lang.Object
- com.fr.third.jgroups.stack.Protocol
- - com.fr.third.jgroups.protocols.RATE_LIMITER

```
public class RATE_LIMITER
extends Protocol
```
Protocol which sends at most max_bytes in time_period milliseconds. Can be used instead of a flow control protocol, e.g. FC or SFC (same position in the stack)

作者:

Bela Ban

字段概要

字段
限定符和类型	字段和说明
`protected long`	`end_of_current_period`
`protected int`	`frag_size`
`protected java.util.concurrent.locks.Lock`	`lock`
`protected long`	`max_bytes`
`protected int`	`num_blockings`
`protected long`	`num_bytes_sent_in_period` Keeps track of the number of bytes sent in the current time period
`protected boolean`	`running`
`protected long`	`time_period`
`protected long`	`time_period_ns`
`protected long`	`total_block_time`

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

构造器概要

构造器
构造器和说明

RATE_LIMITER()

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

方法概要

方法
限定符和类型	方法和说明
`java.lang.Object`	`down(Event evt)` An event is to be sent down the stack.
`double`	`getAverageBlockTime()`
`long`	`getMaxBytes()`
`long`	`getTimePeriod()`
`long`	`getTotalBlockTime()`
`void`	`init()` Called after instance has been created (null constructor) and before protocol is started.
`void`	`resetStats()`
`void`	`setMaxBytes(long max_bytes)`
`void`	`setTimePeriod(long time_period)`
`void`	`start()` This method is called on a `Channel.connect(String)`.
`void`	`stop()` This method is called on a `Channel.disconnect()`.

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

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

- 字段详细资料
  - max_bytes
```
protected long max_bytes
```
  - time_period
```
protected long time_period
```
  - time_period_ns
```
protected long time_period_ns
```
  - num_bytes_sent_in_period
```
protected long num_bytes_sent_in_period
```
    Keeps track of the number of bytes sent in the current time period
  - end_of_current_period
```
protected long end_of_current_period
```
  - lock
```
protected final java.util.concurrent.locks.Lock lock
```
  - num_blockings
```
protected int num_blockings
```
  - total_block_time
```
protected long total_block_time
```
  - frag_size
```
protected int frag_size
```
  - running
```
protected volatile boolean running
```
- 构造器详细资料
  - RATE_LIMITER
```
public RATE_LIMITER()
```
- 方法详细资料
  - getMaxBytes
```
public long getMaxBytes()
```
  - setMaxBytes
```
public void setMaxBytes(long max_bytes)
```
  - getTimePeriod
```
public long getTimePeriod()
```
  - setTimePeriod
```
public void setTimePeriod(long time_period)
```
  - getTotalBlockTime
```
public long getTotalBlockTime()
```
  - getAverageBlockTime
```
public double getAverageBlockTime()
```
  - resetStats
```
public void resetStats()
```
    覆盖:
    
    resetStats 在类中 Protocol
  - init
```
public void init()
          throws java.lang.Exception
```
    从类复制的说明: Protocol
    
    Called after instance has been created (null constructor) and before protocol is started. Properties are already set. Other protocols are not yet connected and events cannot yet be sent.
    
    覆盖:
    
    init 在类中 Protocol
    
    抛出:
    
    java.lang.Exception - Thrown if protocol cannot be initialized successfully. This will cause the ProtocolStack to fail, so the channel constructor will throw an exception
  - 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
  - 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

类 RATE_LIMITER

字段概要

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

构造器概要

方法概要

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

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

字段详细资料

max_bytes

time_period

time_period_ns

num_bytes_sent_in_period

end_of_current_period

lock

num_blockings

total_block_time

frag_size

running

构造器详细资料

RATE_LIMITER

方法详细资料

getMaxBytes

setMaxBytes

getTimePeriod

setTimePeriod

getTotalBlockTime

getAverageBlockTime

resetStats

init

start

stop

down