AbstractTrafficShapingHandler (Netty 3.10.5.Final API文档

java.lang.Object
- org.jboss.netty.channel.SimpleChannelHandler
- - org.jboss.netty.handler.traffic.AbstractTrafficShapingHandler

所有已实现的接口:

ChannelDownstreamHandler, ChannelHandler, ChannelUpstreamHandler, ExternalResourceReleasable

直接已知子类:

ChannelTrafficShapingHandler, GlobalChannelTrafficShapingHandler, GlobalTrafficShapingHandler
```
public abstract class AbstractTrafficShapingHandler
extends SimpleChannelHandler
implements ExternalResourceReleasable
```
AbstractTrafficShapingHandler allows to limit the global bandwidth (see GlobalTrafficShapingHandler) or per session bandwidth (see ChannelTrafficShapingHandler), as traffic shaping. It allows too to implement an almost real time monitoring of the bandwidth using the monitors from TrafficCounter that will call back every checkInterval the method doAccounting of this handler.

An ObjectSizeEstimator can be passed at construction to specify what is the size of the object to be read or write accordingly to the type of object. If not specified, it will used the DefaultObjectSizeEstimator implementation.

If you want for any particular reasons to stop the monitoring (accounting) or to change the read/write limit or the check interval, several methods allow that for you:
- configure allows you to change read or write limits, or the checkInterval
- getTrafficCounter allows you to have access to the TrafficCounter and so to stop or start the monitoring, to change the checkInterval directly, or to have access to its values.

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`AbstractTrafficShapingHandler.SimpleObjectSizeEstimator` For simple ChannelBuffer, returns the readableBytes, else use standard DefaultObjectSizeEstimator.

从接口继承的嵌套类/接口 org.jboss.netty.channel.ChannelHandler
ChannelHandler.Sharable

字段概要

字段
限定符和类型	字段和说明
`protected long`	`checkInterval` Delay between two performance snapshots
`static long`	`DEFAULT_CHECK_INTERVAL` Default delay between two checks: 1s
`static long`	`DEFAULT_MAX_TIME` Default max delay in case of traffic shaping (during which no communication will occur).
`protected long`	`maxTime` Max delay in wait
`protected Timer`	`timer` Timer associated to any TrafficCounter
`protected TrafficCounter`	`trafficCounter` Traffic Counter

构造器概要

构造器
限定符	构造器和说明
`protected`	`AbstractTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer)` Constructor using the specified ObjectSizeEstimator and using NO LIMIT and default Check Interval value of 1000L ms and default max time as delay allowed value of 15000L ms.
`protected`	`AbstractTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer, long checkInterval)` Constructor using the specified ObjectSizeEstimator and using NO LIMIT and default max time as delay allowed value of 15000L ms.
`protected`	`AbstractTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer, long writeLimit, long readLimit)` Constructor using the specified ObjectSizeEstimator and using default Check Interval value of 1000L ms and default max time as delay allowed value of 15000L ms.
`protected`	`AbstractTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer, long writeLimit, long readLimit, long checkInterval)` Constructor using the specified ObjectSizeEstimator and default max time as delay allowed value of 15000L ms.
`protected`	`AbstractTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer, long writeLimit, long readLimit, long checkInterval, long maxTime)` Constructor using the specified ObjectSizeEstimator.
`protected`	`AbstractTrafficShapingHandler(Timer timer)` Constructor using default `ObjectSizeEstimator` and using NO LIMIT and default Check Interval value of 1000L ms and default max time as delay allowed value of 15000L ms.
`protected`	`AbstractTrafficShapingHandler(Timer timer, long checkInterval)` Constructor using default `ObjectSizeEstimator` and using NO LIMIT and default max time as delay allowed value of 15000L ms.
`protected`	`AbstractTrafficShapingHandler(Timer timer, long writeLimit, long readLimit)` Constructor using default `ObjectSizeEstimator` and using default Check Interval value of 1000L ms and default max time as delay allowed value of 15000L ms.
`protected`	`AbstractTrafficShapingHandler(Timer timer, long writeLimit, long readLimit, long checkInterval)` Constructor using default `ObjectSizeEstimator` and default max time as delay allowed value of 15000L ms.
`protected`	`AbstractTrafficShapingHandler(Timer timer, long writeLimit, long readLimit, long checkInterval, long maxTime)` Constructor using default `ObjectSizeEstimator`.

方法概要

方法
限定符和类型	方法和说明
`protected long`	`calculateSize(java.lang.Object obj)`
`void`	`channelConnected(ChannelHandlerContext ctx, ChannelStateEvent e)` Invoked when a `Channel` is open, bound to a local address, and connected to a remote address.
`void`	`configure(long newCheckInterval)` Change the check interval.
`void`	`configure(long newWriteLimit, long newReadLimit)` Change the underlying limitations.
`void`	`configure(long newWriteLimit, long newReadLimit, long newCheckInterval)` Change the underlying limitations and check interval.
`protected void`	`doAccounting(TrafficCounter counter)` Called each time the accounting is computed from the TrafficCounters.
`long`	`getCheckInterval()`
`long`	`getMaxTimeWait()`
`long`	`getMaxWriteDelay()`
`long`	`getMaxWriteSize()`
`long`	`getReadLimit()`
`TrafficCounter`	`getTrafficCounter()`
`long`	`getWriteLimit()`
`protected void`	`internalSubmitWrite(ChannelHandlerContext ctx, MessageEvent evt)` 已过时。
`void`	`messageReceived(ChannelHandlerContext ctx, MessageEvent evt)` Invoked when a message object (e.g: `ChannelBuffer`) was received from a remote peer.
`void`	`releaseExternalResources()` Releases the external resources that this object depends on.
`void`	`setCheckInterval(long newCheckInterval)`
`void`	`setMaxTimeWait(long maxTime)` Note the change will be taken as best effort, meaning that all already scheduled traffics will not be changed, but only applied to new traffics.
`void`	`setMaxWriteDelay(long maxWriteDelay)` Note the change will be taken as best effort, meaning that all already scheduled traffics will not be changed, but only applied to new traffics.
`void`	`setMaxWriteSize(long maxWriteSize)` Note the change will be taken as best effort, meaning that all already scheduled traffics will not be changed, but only applied to new traffics.
`void`	`setReadLimit(long readLimit)` Note the change will be taken as best effort, meaning that all already scheduled traffics will not be changed, but only applied to new traffics.
`void`	`setWriteLimit(long writeLimit)` Note the change will be taken as best effort, meaning that all already scheduled traffics will not be changed, but only applied to new traffics.
`protected void`	`submitWrite(ChannelHandlerContext ctx, MessageEvent evt, long delay)` 已过时。
`java.lang.String`	`toString()`
`void`	`writeRequested(ChannelHandlerContext ctx, MessageEvent evt)` Invoked when `Channel.write(Object)` is called.

从类继承的方法 org.jboss.netty.channel.SimpleChannelHandler
bindRequested, channelBound, channelClosed, channelDisconnected, channelInterestChanged, channelOpen, channelUnbound, childChannelClosed, childChannelOpen, closeRequested, connectRequested, disconnectRequested, exceptionCaught, handleDownstream, handleUpstream, setInterestOpsRequested, unbindRequested, writeComplete

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

- 字段详细资料
  - DEFAULT_CHECK_INTERVAL
```
public static final long DEFAULT_CHECK_INTERVAL
```
    Default delay between two checks: 1s
    
    另请参阅:
    常量字段值
  - DEFAULT_MAX_TIME
```
public static final long DEFAULT_MAX_TIME
```
    Default max delay in case of traffic shaping (during which no communication will occur). Shall be less than TIMEOUT. Here half of "standard" 30s
    
    另请参阅:
    常量字段值
  - trafficCounter
```
protected TrafficCounter trafficCounter
```
    Traffic Counter
  - timer
```
protected Timer timer
```
    Timer associated to any TrafficCounter
  - checkInterval
```
protected volatile long checkInterval
```
    Delay between two performance snapshots
  - maxTime
```
protected volatile long maxTime
```
    Max delay in wait
- 构造器详细资料
  - AbstractTrafficShapingHandler
```
protected AbstractTrafficShapingHandler(Timer timer,
                             long writeLimit,
                             long readLimit,
                             long checkInterval)
```
    Constructor using default ObjectSizeEstimator and default max time as delay allowed value of 15000L ms.
    
    参数:
    timer - created once for instance like HashedWheelTimer(10, TimeUnit.MILLISECONDS, 1024).
    writeLimit - 0 or a limit in bytes/s
    readLimit - 0 or a limit in bytes/s
    checkInterval - The delay between two computations of performances for channels or 0 if no stats are to be computed.
  - AbstractTrafficShapingHandler
```
protected AbstractTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator,
                             Timer timer,
                             long writeLimit,
                             long readLimit,
                             long checkInterval)
```
    Constructor using the specified ObjectSizeEstimator and default max time as delay allowed value of 15000L ms.
    
    参数:
    objectSizeEstimator - the ObjectSizeEstimator that will be used to compute the size of the message.
    timer - created once for instance like HashedWheelTimer(10, TimeUnit.MILLISECONDS, 1024).
    writeLimit - 0 or a limit in bytes/s
    readLimit - 0 or a limit in bytes/s
    checkInterval - The delay between two computations of performances for channels or 0 if no stats are to be computed.
  - AbstractTrafficShapingHandler
```
protected AbstractTrafficShapingHandler(Timer timer,
                             long writeLimit,
                             long readLimit)
```
    Constructor using default ObjectSizeEstimator and using default Check Interval value of 1000L ms and default max time as delay allowed value of 15000L ms.
    
    参数:
    timer - created once for instance like HashedWheelTimer(10, TimeUnit.MILLISECONDS, 1024).
    writeLimit - 0 or a limit in bytes/s
    readLimit - 0 or a limit in bytes/s
  - AbstractTrafficShapingHandler
```
protected AbstractTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator,
                             Timer timer,
                             long writeLimit,
                             long readLimit)
```
    Constructor using the specified ObjectSizeEstimator and using default Check Interval value of 1000L ms and default max time as delay allowed value of 15000L ms.
    
    参数:
    objectSizeEstimator - the ObjectSizeEstimator that will be used to compute the size of the message.
    timer - created once for instance like HashedWheelTimer(10, TimeUnit.MILLISECONDS, 1024).
    writeLimit - 0 or a limit in bytes/s
    readLimit - 0 or a limit in bytes/s
  - AbstractTrafficShapingHandler
```
protected AbstractTrafficShapingHandler(Timer timer)
```
    Constructor using default ObjectSizeEstimator and using NO LIMIT and default Check Interval value of 1000L ms and default max time as delay allowed value of 15000L ms.
    
    参数:
    timer - created once for instance like HashedWheelTimer(10, TimeUnit.MILLISECONDS, 1024).
  - AbstractTrafficShapingHandler
```
protected AbstractTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator,
                             Timer timer)
```
    Constructor using the specified ObjectSizeEstimator and using NO LIMIT and default Check Interval value of 1000L ms and default max time as delay allowed value of 15000L ms.
    
    参数:
    objectSizeEstimator - the ObjectSizeEstimator that will be used to compute the size of the message.
    timer - created once for instance like HashedWheelTimer(10, TimeUnit.MILLISECONDS, 1024).
  - AbstractTrafficShapingHandler
```
protected AbstractTrafficShapingHandler(Timer timer,
                             long checkInterval)
```
    Constructor using default ObjectSizeEstimator and using NO LIMIT and default max time as delay allowed value of 15000L ms.
    
    参数:
    timer - created once for instance like HashedWheelTimer(10, TimeUnit.MILLISECONDS, 1024).
    checkInterval - The delay between two computations of performances for channels or 0 if no stats are to be computed.
  - AbstractTrafficShapingHandler
```
protected AbstractTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator,
                             Timer timer,
                             long checkInterval)
```
    Constructor using the specified ObjectSizeEstimator and using NO LIMIT and default max time as delay allowed value of 15000L ms.
    
    参数:
    objectSizeEstimator - the ObjectSizeEstimator that will be used to compute the size of the message.
    timer - created once for instance like HashedWheelTimer(10, TimeUnit.MILLISECONDS, 1024).
    checkInterval - The delay between two computations of performances for channels or 0 if no stats are to be computed.
  - AbstractTrafficShapingHandler
```
protected AbstractTrafficShapingHandler(Timer timer,
                             long writeLimit,
                             long readLimit,
                             long checkInterval,
                             long maxTime)
```
    Constructor using default ObjectSizeEstimator.
    
    参数:
    timer - created once for instance like HashedWheelTimer(10, TimeUnit.MILLISECONDS, 1024).
    writeLimit - 0 or a limit in bytes/s
    readLimit - 0 or a limit in bytes/s
    checkInterval - The delay between two computations of performances for channels or 0 if no stats are to be computed.
    maxTime - The max time to wait in case of excess of traffic (to prevent Time Out event). Must be positive.
  - AbstractTrafficShapingHandler
```
protected AbstractTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator,
                             Timer timer,
                             long writeLimit,
                             long readLimit,
                             long checkInterval,
                             long maxTime)
```
    Constructor using the specified ObjectSizeEstimator.
    
    参数:
    objectSizeEstimator - the ObjectSizeEstimator that will be used to compute the size of the message.
    timer - created once for instance like HashedWheelTimer(10, TimeUnit.MILLISECONDS, 1024).
    writeLimit - 0 or a limit in bytes/s
    readLimit - 0 or a limit in bytes/s
    checkInterval - The delay between two computations of performances for channels or 0 if no stats are to be computed.
    maxTime - The max time to wait in case of excess of traffic (to prevent Time Out event). Must be positive.
- 方法详细资料
  - configure
```
public void configure(long newWriteLimit,
             long newReadLimit,
             long newCheckInterval)
```
    Change the underlying limitations and check interval.
    Note the change will be taken as best effort, meaning that all already scheduled traffics will not be changed, but only applied to new traffics.
    So the expected usage of this method is to be used not too often, accordingly to the traffic shaping configuration.
    
    参数:
    newWriteLimit - The new write limit (in bytes)
    newReadLimit - The new read limit (in bytes)
    newCheckInterval - The new check interval (in milliseconds)
  - configure
```
public void configure(long newWriteLimit,
             long newReadLimit)
```
    Change the underlying limitations.
    Note the change will be taken as best effort, meaning that all already scheduled traffics will not be changed, but only applied to new traffics.
    So the expected usage of this method is to be used not too often, accordingly to the traffic shaping configuration.
    
    参数:
    newWriteLimit - The new write limit (in bytes)
    newReadLimit - The new read limit (in bytes)
  - configure
```
public void configure(long newCheckInterval)
```
    Change the check interval.
  - getWriteLimit
```
public long getWriteLimit()
```
    返回:
    the writeLimit
  - setWriteLimit
```
public void setWriteLimit(long writeLimit)
```
    Note the change will be taken as best effort, meaning that all already scheduled traffics will not be changed, but only applied to new traffics.
    So the expected usage of this method is to be used not too often, accordingly to the traffic shaping configuration.
    
    参数:
    writeLimit - the writeLimit to set
  - getReadLimit
```
public long getReadLimit()
```
    返回:
    the readLimit
  - setReadLimit
```
public void setReadLimit(long readLimit)
```
    Note the change will be taken as best effort, meaning that all already scheduled traffics will not be changed, but only applied to new traffics.
    So the expected usage of this method is to be used not too often, accordingly to the traffic shaping configuration.
    
    参数:
    readLimit - the readLimit to set
  - getCheckInterval
```
public long getCheckInterval()
```
    返回:
    the checkInterval
  - setCheckInterval
```
public void setCheckInterval(long newCheckInterval)
```
    参数:
    newCheckInterval - the checkInterval to set
  - getMaxTimeWait
```
public long getMaxTimeWait()
```
    返回:
    the max delay on wait
  - setMaxTimeWait
```
public void setMaxTimeWait(long maxTime)
```
    Note the change will be taken as best effort, meaning that all already scheduled traffics will not be changed, but only applied to new traffics.
    So the expected usage of this method is to be used not too often, accordingly to the traffic shaping configuration.
    
    参数:
    maxTime - Max delay in wait, shall be less than TIME OUT in related protocol. Must be positive.
  - getMaxWriteDelay
```
public long getMaxWriteDelay()
```
    返回:
    the maxWriteDelay
  - setMaxWriteDelay
```
public void setMaxWriteDelay(long maxWriteDelay)
```
    Note the change will be taken as best effort, meaning that all already scheduled traffics will not be changed, but only applied to new traffics.
    So the expected usage of this method is to be used not too often, accordingly to the traffic shaping configuration.
    
    参数:
    maxWriteDelay - the maximum Write Delay in ms in the buffer allowed before write suspended is set. Must be positive.
  - getMaxWriteSize
```
public long getMaxWriteSize()
```
    返回:
    the maxWriteSize default being bytes
  - setMaxWriteSize
```
public void setMaxWriteSize(long maxWriteSize)
```
    Note the change will be taken as best effort, meaning that all already scheduled traffics will not be changed, but only applied to new traffics.
    So the expected usage of this method is to be used not too often, accordingly to the traffic shaping configuration.
    
    参数:
    maxWriteSize - the maximum Write Size allowed in the buffer per channel before write suspended is set, default being bytes
  - doAccounting
```
protected void doAccounting(TrafficCounter counter)
```
    Called each time the accounting is computed from the TrafficCounters. This method could be used for instance to implement almost real time accounting.
    
    参数:
    counter - the TrafficCounter that computes its performance
  - messageReceived
```
public void messageReceived(ChannelHandlerContext ctx,
                   MessageEvent evt)
                     throws java.lang.Exception
```
    从类复制的说明: SimpleChannelHandler
    
    Invoked when a message object (e.g: ChannelBuffer) was received from a remote peer.
    
    覆盖:
    
    messageReceived 在类中 SimpleChannelHandler
    
    抛出:
    
    java.lang.Exception
  - writeRequested
```
public void writeRequested(ChannelHandlerContext ctx,
                  MessageEvent evt)
                    throws java.lang.Exception
```
    从类复制的说明: SimpleChannelHandler
    
    Invoked when Channel.write(Object) is called.
    
    覆盖:
    
    writeRequested 在类中 SimpleChannelHandler
    
    抛出:
    
    java.lang.Exception
  - internalSubmitWrite
```
@Deprecated
protected void internalSubmitWrite(ChannelHandlerContext ctx,
                                  MessageEvent evt)
                            throws java.lang.Exception
```
    已过时。
    
    抛出:
    
    java.lang.Exception
  - submitWrite
```
@Deprecated
protected void submitWrite(ChannelHandlerContext ctx,
                          MessageEvent evt,
                          long delay)
                    throws java.lang.Exception
```
    已过时。
    
    抛出:
    
    java.lang.Exception
  - getTrafficCounter
```
public TrafficCounter getTrafficCounter()
```
    返回:
    the current TrafficCounter (if channel is still connected).
  - releaseExternalResources
```
public void releaseExternalResources()
```
    从接口复制的说明: ExternalResourceReleasable
    
    Releases the external resources that this object depends on. You should not call this method if the external resources (e.g. thread pool) are in use by other objects.
    
    指定者:
    
    releaseExternalResources 在接口中 ExternalResourceReleasable
  - channelConnected
```
public void channelConnected(ChannelHandlerContext ctx,
                    ChannelStateEvent e)
                      throws java.lang.Exception
```
    从类复制的说明: SimpleChannelHandler
    
    Invoked when a Channel is open, bound to a local address, and connected to a remote address.
    
    覆盖:
    
    channelConnected 在类中 SimpleChannelHandler
    
    抛出:
    
    java.lang.Exception
  - calculateSize
```
protected long calculateSize(java.lang.Object obj)
```
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object

类 AbstractTrafficShapingHandler

嵌套类概要

从接口继承的嵌套类/接口 org.jboss.netty.channel.ChannelHandler

字段概要

构造器概要

方法概要

从类继承的方法 org.jboss.netty.channel.SimpleChannelHandler

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

字段详细资料

DEFAULT_CHECK_INTERVAL

DEFAULT_MAX_TIME

trafficCounter

timer

checkInterval

maxTime

构造器详细资料

AbstractTrafficShapingHandler

AbstractTrafficShapingHandler

AbstractTrafficShapingHandler

AbstractTrafficShapingHandler

AbstractTrafficShapingHandler

AbstractTrafficShapingHandler

AbstractTrafficShapingHandler

AbstractTrafficShapingHandler

AbstractTrafficShapingHandler

AbstractTrafficShapingHandler

方法详细资料

configure

configure

configure

getWriteLimit

setWriteLimit

getReadLimit

setReadLimit

getCheckInterval

setCheckInterval

getMaxTimeWait

setMaxTimeWait

getMaxWriteDelay

setMaxWriteDelay

getMaxWriteSize

setMaxWriteSize

doAccounting

messageReceived

writeRequested

internalSubmitWrite

submitWrite

getTrafficCounter

releaseExternalResources

channelConnected

calculateSize

toString