TrafficCounter (Netty 3.10.5.Final API文档

java.lang.Object
- org.jboss.netty.handler.traffic.TrafficCounter

直接已知子类:

GlobalChannelTrafficCounter
```
public class TrafficCounter
extends java.lang.Object
```
TrafficCounter is associated with AbstractTrafficShapingHandler.
A TrafficCounter has for goal to count the traffic in order to enable to limit the traffic or not, globally or per channel. It compute statistics on read and written bytes at the specified interval and call back the AbstractTrafficShapingHandler doAccounting method at every specified interval. If this interval is set to 0, therefore no accounting will be done and only statistics will be computed at each receive or write operations.

构造器概要

构造器
构造器和说明
`TrafficCounter(AbstractTrafficShapingHandler trafficShapingHandler, Timer timer, java.lang.String name, long checkInterval)` Constructor with the `AbstractTrafficShapingHandler` that hosts it, the Timer to use, its name, the checkInterval between two computations in millisecond.

方法概要

方法
限定符和类型	方法和说明
`void`	`configure(long newcheckInterval)` Change checkInterval between two computations in millisecond.
`long`	`getCheckInterval()`
`long`	`getCumulativeReadBytes()`
`long`	`getCumulativeWrittenBytes()`
`long`	`getCurrentReadBytes()`
`long`	`getCurrentWrittenBytes()`
`long`	`getLastCumulativeTime()`
`long`	`getLastReadBytes()`
`long`	`getLastReadThroughput()`
`long`	`getLastTime()`
`long`	`getLastWriteThroughput()`
`long`	`getLastWrittenBytes()`
`java.lang.String`	`getName()`
`long`	`getRealWriteThroughput()`
`java.util.concurrent.atomic.AtomicLong`	`getRealWrittenBytes()`
`static long`	`milliSecondFromNano()`
`long`	`readTimeToWait(long size, long limitTraffic, long maxTime)` 已过时。
`long`	`readTimeToWait(long size, long limitTraffic, long maxTime, long now)` Returns the time to wait (if any) for the given length message, using the given limitTraffic and the max wait time.
`void`	`resetCumulativeTime()` Reset both read and written cumulative bytes counters and the associated absolute time from System.currentTimeMillis().
`void`	`start()` Start the monitoring process.
`void`	`stop()` Stop the monitoring process.
`java.lang.String`	`toString()` String information
`long`	`writeTimeToWait(long size, long limitTraffic, long maxTime)` 已过时。
`long`	`writeTimeToWait(long size, long limitTraffic, long maxTime, long now)` Returns the time to wait (if any) for the given length message, using the given limitTraffic and the max wait time.

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

- 构造器详细资料
  - TrafficCounter
```
public TrafficCounter(AbstractTrafficShapingHandler trafficShapingHandler,
              Timer timer,
              java.lang.String name,
              long checkInterval)
```
    Constructor with the AbstractTrafficShapingHandler that hosts it, the Timer to use, its name, the checkInterval between two computations in millisecond.
    
    参数:
    trafficShapingHandler - the associated AbstractTrafficShapingHandler
    timer - Could be a HashedWheelTimer, might be null when used from GlobalChannelTrafficCounter.
    name - the name given to this monitor
    checkInterval - the checkInterval in millisecond between two computations.
- 方法详细资料
  - milliSecondFromNano
```
public static long milliSecondFromNano()
```
    返回:
    the time in ms using nanoTime, so not real EPOCH time but elapsed time in ms.
  - start
```
public void start()
```
    Start the monitoring process.
  - stop
```
public void stop()
```
    Stop the monitoring process.
  - configure
```
public void configure(long newcheckInterval)
```
    Change checkInterval between two computations in millisecond.
  - getCheckInterval
```
public long getCheckInterval()
```
    返回:
    the current checkInterval between two computations of traffic counter in millisecond.
  - getLastReadThroughput
```
public long getLastReadThroughput()
```
    返回:
    the Read Throughput in bytes/s computes in the last check interval.
  - getLastWriteThroughput
```
public long getLastWriteThroughput()
```
    返回:
    the Write Throughput in bytes/s computes in the last check interval.
  - getLastReadBytes
```
public long getLastReadBytes()
```
    返回:
    the number of bytes read during the last check Interval.
  - getLastWrittenBytes
```
public long getLastWrittenBytes()
```
    返回:
    the number of bytes written during the last check Interval.
  - getCurrentReadBytes
```
public long getCurrentReadBytes()
```
    返回:
    the current number of bytes read since the last checkInterval.
  - getCurrentWrittenBytes
```
public long getCurrentWrittenBytes()
```
    返回:
    the current number of bytes written since the last check Interval.
  - getLastTime
```
public long getLastTime()
```
    返回:
    the Time in millisecond of the last check as of System.currentTimeMillis().
  - getCumulativeWrittenBytes
```
public long getCumulativeWrittenBytes()
```
    返回:
    the cumulativeWrittenBytes
  - getCumulativeReadBytes
```
public long getCumulativeReadBytes()
```
    返回:
    the cumulativeReadBytes
  - getLastCumulativeTime
```
public long getLastCumulativeTime()
```
    返回:
    the lastCumulativeTime in millisecond as of System.currentTimeMillis() when the cumulative counters were reset to 0.
  - getRealWrittenBytes
```
public java.util.concurrent.atomic.AtomicLong getRealWrittenBytes()
```
    返回:
    the realWrittenBytes
  - getRealWriteThroughput
```
public long getRealWriteThroughput()
```
    返回:
    the realWriteThroughput
  - resetCumulativeTime
```
public void resetCumulativeTime()
```
    Reset both read and written cumulative bytes counters and the associated absolute time from System.currentTimeMillis().
  - readTimeToWait
```
@Deprecated
public long readTimeToWait(long size,
                             long limitTraffic,
                             long maxTime)
```
    已过时。
    
    Returns the time to wait (if any) for the given length message, using the given limitTraffic and the max wait time.
    
    参数:
    size - the recv size
    limitTraffic - the traffic limit in bytes per second
    maxTime - the max time in ms to wait in case of excess of traffic.
    
    返回:
    the current time to wait (in ms) if needed for Read operation.
  - readTimeToWait
```
public long readTimeToWait(long size,
                  long limitTraffic,
                  long maxTime,
                  long now)
```
    Returns the time to wait (if any) for the given length message, using the given limitTraffic and the max wait time.
    
    参数:
    size - the recv size
    limitTraffic - the traffic limit in bytes per second
    maxTime - the max time in ms to wait in case of excess of traffic.
    now - the current time
    
    返回:
    the current time to wait (in ms) if needed for Read operation.
  - writeTimeToWait
```
@Deprecated
public long writeTimeToWait(long size,
                              long limitTraffic,
                              long maxTime)
```
    已过时。
    
    Returns the time to wait (if any) for the given length message, using the given limitTraffic and the max wait time.
    
    参数:
    size - the write size
    limitTraffic - the traffic limit in bytes per second
    maxTime - the max time in ms to wait in case of excess of traffic.
    
    返回:
    the current time to wait (in ms) if needed for Write operation.
  - writeTimeToWait
```
public long writeTimeToWait(long size,
                   long limitTraffic,
                   long maxTime,
                   long now)
```
    Returns the time to wait (if any) for the given length message, using the given limitTraffic and the max wait time.
    
    参数:
    size - the write size
    limitTraffic - the traffic limit in bytes per second
    maxTime - the max time in ms to wait in case of excess of traffic.
    now - the current time
    
    返回:
    the current time to wait (in ms) if needed for Write operation.
  - getName
```
public java.lang.String getName()
```
    返回:
    the name
  - toString
```
public java.lang.String toString()
```
    String information
    
    覆盖:
    
    toString 在类中 java.lang.Object

类 TrafficCounter

构造器概要

方法概要

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

构造器详细资料

TrafficCounter

方法详细资料

milliSecondFromNano

start

stop

configure

getCheckInterval

getLastReadThroughput

getLastWriteThroughput

getLastReadBytes

getLastWrittenBytes

getCurrentReadBytes

getCurrentWrittenBytes

getLastTime

getCumulativeWrittenBytes

getCumulativeReadBytes

getLastCumulativeTime

getRealWrittenBytes

getRealWriteThroughput

resetCumulativeTime

readTimeToWait

readTimeToWait

writeTimeToWait

writeTimeToWait

getName

toString