GlobalChannelTrafficShapingHandler (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.channel.ChannelHandlerAdapter
- - io.netty.channel.ChannelInboundHandlerAdapter
  - - io.netty.channel.ChannelDuplexHandler
    - - io.netty.handler.traffic.AbstractTrafficShapingHandler
      - io.netty.handler.traffic.GlobalChannelTrafficShapingHandler

All Implemented Interfaces:

ChannelHandler ， ChannelInboundHandler ， ChannelOutboundHandler
```
@ChannelHandler.Sharable
public class GlobalChannelTrafficShapingHandler
extends AbstractTrafficShapingHandler
```
AbstractTrafficShapingHandler的这种实现方式适用于全局和每信道流量整形，也就是全球带宽限制，无论开放通道的数量和每个通道的带宽限制如何。

此版本与其他TrafficShapingHandler不在同一管道中。

一般用途应该如下：
- 创建您的独特GlobalChannelTrafficShapingHandler，如：
  
  GlobalChannelTrafficShapingHandler myHandler = new GlobalChannelTrafficShapingHandler(executor);
  
  执行者可以是底层的IO工作者池
  pipeline.addLast(myHandler);
  
  请注意，此处理程序的管道覆盖范围为“全部”，这意味着只有一个此类处理程序必须在所有通道中创建和共享，因为计数器必须在所有通道之间共享。
  
  其他参数可以像写入或读取限制（以字节/秒表示，其中0表示没有限制）或表示带宽的两次计算之间的延迟的检查间隔（以毫秒为单位）传递，因此doAccounting方法的回调（0意味着根本没有会计）。
  请注意，由于这是全球和通道流量整形的融合，所以限制分别为2组，分别为全局和通道。
  
  值为0意味着不计入checkInterval。如果您需要流量整形，但没有此类记帐，建议设置一个正值，即使该值较高，因为流量整形的精度取决于流量计算的时间段。时间间隔越高，流量整形的精确度越低。建议接近5或10分钟的值更高。
  
  maxTimeToWait默认设置为15秒，允许指定时间整形的上限。
- 在您的处理程序中，您应该考虑使用channel.isWritable()和channelWritabilityChanged(ctx)来处理可写性，或者通过future.addListener(new GenericFutureListener())返回将来返回的ctx.write() 。
- 您还应该考虑在读取或写入操作时使用的对象大小与您所需的带宽相对匹配：例如，10KB / s的10 MB对象将导致突发效应，而1 MB / s的100 KB对象应该平滑由此TrafficShaping处理程序处理。
- 一些配置方法将被视为尽力而为，这意味着所有已安排的流量都不会改变，但仅适用于新的流量。
  所以这些方法的预期用途不应该太频繁地使用，因此对于流量整形配置。
一旦这个处理程序不再需要，一定要调用release()来释放所有内部资源。这不会关闭EventExecutor，因为它可能是共享的，所以你需要自己做。

Nested Class Summary
- Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler
  ChannelHandler.Sharable

Field Summary
- Fields inherited from class io.netty.handler.traffic.AbstractTrafficShapingHandler
  checkInterval, DEFAULT_CHECK_INTERVAL, DEFAULT_MAX_TIME, maxTime, trafficCounter

构造方法摘要

构造方法
Constructor and Description
`GlobalChannelTrafficShapingHandler(java.util.concurrent.ScheduledExecutorService executor)` 创建一个新的实例。
`GlobalChannelTrafficShapingHandler(java.util.concurrent.ScheduledExecutorService executor, long checkInterval)` 创建一个新的实例。
`GlobalChannelTrafficShapingHandler(java.util.concurrent.ScheduledExecutorService executor, long writeGlobalLimit, long readGlobalLimit, long writeChannelLimit, long readChannelLimit)` 创建一个新的实例。
`GlobalChannelTrafficShapingHandler(java.util.concurrent.ScheduledExecutorService executor, long writeGlobalLimit, long readGlobalLimit, long writeChannelLimit, long readChannelLimit, long checkInterval)` 创建一个新的实例。
`GlobalChannelTrafficShapingHandler(java.util.concurrent.ScheduledExecutorService executor, long writeGlobalLimit, long readGlobalLimit, long writeChannelLimit, long readChannelLimit, long checkInterval, long maxTime)` 创建一个新的实例。

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`float`	`accelerationFactor()`
`void`	`channelRead(ChannelHandlerContext ctx, java.lang.Object msg)` 致电`ChannelHandlerContext.fireChannelRead(Object)`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`java.util.Collection<TrafficCounter>`	`channelTrafficCounters()` 例如，允许doAccounting使用每个频道的TrafficCounter。
`protected long`	`checkWaitReadTime(ChannelHandlerContext ctx, long wait, long now)` 在GTSH中覆盖的方法考虑到通道的特定定时器。
`void`	`configureChannel(long newWriteLimit, long newReadLimit)`
`protected void`	`doAccounting(TrafficCounter counter)` 每次从TrafficCounters计算会计时调用。
`long`	`getMaxGlobalWriteSize()`
`long`	`getReadChannelLimit()`
`long`	`getWriteChannelLimit()`
`void`	`handlerAdded(ChannelHandlerContext ctx)` 子类可以忽略这个方法。
`void`	`handlerRemoved(ChannelHandlerContext ctx)` 子类可以忽略这个方法。
`protected void`	`informReadOperation(ChannelHandlerContext ctx, long now)` 在GTSH中覆盖的方法考虑到通道的特定定时器。
`float`	`maxDeviation()`
`protected long`	`maximumCumulativeReadBytes()`
`protected long`	`maximumCumulativeWrittenBytes()`
`long`	`queuesSize()`
`void`	`release()` 释放此实例的所有内部资源。
`void`	`setMaxDeviation(float maxDeviation, float slowDownFactor, float accelerationFactor)`
`void`	`setMaxGlobalWriteSize(long maxGlobalWriteSize)` 请注意，更改将被视为尽力而为，这意味着所有已计划的流量都不会改变，但仅适用于新的流量。
`void`	`setReadChannelLimit(long readLimit)`
`void`	`setWriteChannelLimit(long writeLimit)`
`float`	`slowDownFactor()`
`protected void`	`submitWrite(ChannelHandlerContext ctx, java.lang.Object msg, long size, long writedelay, long now, ChannelPromise promise)`
`java.lang.String`	`toString()`
`protected int`	`userDefinedWritabilityIndex()`
`void`	`write(ChannelHandlerContext ctx, java.lang.Object msg, ChannelPromise promise)` 致电`ChannelOutboundInvoker.write(Object, ChannelPromise)`转发到`ChannelPipeline`中的下一个`ChannelOutboundHandler` 。

Methods inherited from class io.netty.handler.traffic.AbstractTrafficShapingHandler
calculateSize, channelRegistered, configure, configure, configure, getCheckInterval, getMaxTimeWait, getMaxWriteDelay, getMaxWriteSize, getReadLimit, getWriteLimit, isHandlerActive, read, setCheckInterval, setMaxTimeWait, setMaxWriteDelay, setMaxWriteSize, setReadLimit, setWriteLimit, submitWrite, trafficCounter

Methods inherited from class io.netty.channel.ChannelDuplexHandler
bind, close, connect, deregister, disconnect, flush

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter
channelActive, channelInactive, channelReadComplete, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter
ensureNotSharable, isSharable

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.netty.channel.ChannelHandler
exceptionCaught

- 构造方法详细信息
  - GlobalChannelTrafficShapingHandler
```
public GlobalChannelTrafficShapingHandler(java.util.concurrent.ScheduledExecutorService executor,
                                          long writeGlobalLimit,
                                          long readGlobalLimit,
                                          long writeChannelLimit,
                                          long readChannelLimit,
                                          long checkInterval,
                                          long maxTime)
```
    创建一个新的实例。
    
    参数
    
    executor - 用于ScheduledExecutorService的ScheduledExecutorService 。
    
    writeGlobalLimit - 0或以字节/秒为单位的限制
    
    readGlobalLimit - 0或以字节/秒为单位的限制
    
    writeChannelLimit - 0或以字节/秒为单位的限制
    
    readChannelLimit - 0或以字节/秒为单位的限制
    
    checkInterval - 通道的两次性能计算之间的延迟，如果不计算统计数据，则延迟0。
    
    maxTime - maxTime等待的最大延迟时间。
  - GlobalChannelTrafficShapingHandler
```
public GlobalChannelTrafficShapingHandler(java.util.concurrent.ScheduledExecutorService executor,
                                          long writeGlobalLimit,
                                          long readGlobalLimit,
                                          long writeChannelLimit,
                                          long readChannelLimit,
                                          long checkInterval)
```
    创建一个新的实例。
    
    参数
    
    executor - 用于ScheduledExecutorService的ScheduledExecutorService 。
    
    writeGlobalLimit - 0或以字节/秒为单位的限制
    
    readGlobalLimit - 0或以字节/秒为单位的限制
    
    writeChannelLimit - 0或以字节/秒为单位的限制
    
    readChannelLimit - 0或以字节/秒为单位的限制
    
    checkInterval - 通道两次性能计算之间的延迟，如果不计算统计数据，则延迟0。
  - GlobalChannelTrafficShapingHandler
```
public GlobalChannelTrafficShapingHandler(java.util.concurrent.ScheduledExecutorService executor,
                                          long writeGlobalLimit,
                                          long readGlobalLimit,
                                          long writeChannelLimit,
                                          long readChannelLimit)
```
    创建一个新的实例。
    
    参数
    
    executor - 用于ScheduledExecutorService的ScheduledExecutorService 。
    
    writeGlobalLimit - 0或以字节/秒为单位的限制
    
    readGlobalLimit - 0或以字节/秒为单位的限制
    
    writeChannelLimit - 0或以字节/秒为单位的限制
    
    readChannelLimit - 0或以字节/秒为单位的限制
  - GlobalChannelTrafficShapingHandler
```
public GlobalChannelTrafficShapingHandler(java.util.concurrent.ScheduledExecutorService executor,
                                          long checkInterval)
```
    创建一个新的实例。
    
    参数
    
    executor - 用于ScheduledExecutorService的ScheduledExecutorService 。
    
    checkInterval - 通道两次性能计算之间的延迟，如果不计算统计数据，则延迟0。
  - GlobalChannelTrafficShapingHandler
```
public GlobalChannelTrafficShapingHandler(java.util.concurrent.ScheduledExecutorService executor)
```
    创建一个新的实例。
    
    参数
    
    executor - 用于ScheduledExecutorService的ScheduledExecutorService 。
- 方法详细信息
  - userDefinedWritabilityIndex
```
protected int userDefinedWritabilityIndex()
```
    重写：
    
    userDefinedWritabilityIndex在课堂上 AbstractTrafficShapingHandler
    
    结果
    
    TrafficShapingHandler用来管理用户定义的可写性的索引。对于通道TSH，它被定义为：对于全局TSH，它被定义为：对于GlobalChannel TSH它被定义为。
  - maxDeviation
```
public float maxDeviation()
```
    结果
    
    当前的最大偏差
  - accelerationFactor
```
public float accelerationFactor()
```
    结果
    
    当前的加速因子
  - slowDownFactor
```
public float slowDownFactor()
```
    结果
    
    目前的减速因素
  - setMaxDeviation
```
public void setMaxDeviation(float maxDeviation,
                            float slowDownFactor,
                            float accelerationFactor)
```
    参数
    
    maxDeviation - 计算平均值时允许的最大偏差，默认偏差为0.1，因此为所需带宽的+/- 10％。最大值为0.4。
    
    slowDownFactor - 将因子设置为+ x％给客户太快（最小值为0，意味着没有减速因子），默认值为40％（0.4）。
    
    accelerationFactor - 将因子设置为-x％给客户端太慢（最大值为0，意味着没有加速因子），默认值为-10％（-0.1）。
  - doAccounting
```
protected void doAccounting(TrafficCounter counter)
```
    从类复制的描述： AbstractTrafficShapingHandler
    
    每次从TrafficCounters计算会计时调用。这个方法可以用来实现几乎实时的会计。
    
    重写：
    
    doAccounting在课堂上 AbstractTrafficShapingHandler
    
    参数
    
    counter - 计算其性能的 counter
  - getMaxGlobalWriteSize
```
public long getMaxGlobalWriteSize()
```
    结果
    
    maxGlobalWriteSize
  - setMaxGlobalWriteSize
```
public void setMaxGlobalWriteSize(long maxGlobalWriteSize)
```
    请注意，更改将被视为尽力而为，这意味着所有已计划的流量都不会改变，但仅适用于新的流量。
    所以这种方法的预期用法不是太频繁地使用，因此对于流量整形配置。
    
    参数
    
    maxGlobalWriteSize - 设置写暂停之前缓冲区全局允许的最大全局写入大小。
  - queuesSize
```
public long queuesSize()
```
    结果
    
    所有队列的全局缓冲区大小。
  - configureChannel
```
public void configureChannel(long newWriteLimit,
                             long newReadLimit)
```
    参数
    
    newWriteLimit - 通道写入限制
    
    newReadLimit - 通道读取限制
  - getWriteChannelLimit
```
public long getWriteChannelLimit()
```
    结果
    
    通道写入限制
  - setWriteChannelLimit
```
public void setWriteChannelLimit(long writeLimit)
```
    参数
    
    writeLimit - 通道写入限制
  - getReadChannelLimit
```
public long getReadChannelLimit()
```
    结果
    
    通道读取限制
  - setReadChannelLimit
```
public void setReadChannelLimit(long readLimit)
```
    参数
    
    readLimit - 通道读取限制
  - release
```
public final void release()
```
    释放此实例的所有内部资源。
  - handlerAdded
```
public void handlerAdded(ChannelHandlerContext ctx)
                  throws java.lang.Exception
```
    从类复制的描述： ChannelHandlerAdapter
    
    子类可以忽略这个方法。
    
    Specified by:
    
    handlerAdded在界面 ChannelHandler
    
    重写：
    
    handlerAdded在课堂上 ChannelHandlerAdapter
    
    异常
    
    java.lang.Exception
  - handlerRemoved
```
public void handlerRemoved(ChannelHandlerContext ctx)
                    throws java.lang.Exception
```
    从类复制的描述： ChannelHandlerAdapter
    
    子类可以忽略这个方法。
    
    Specified by:
    
    handlerRemoved在界面 ChannelHandler
    
    重写：
    
    handlerRemoved在课堂上 ChannelHandlerAdapter
    
    异常
    
    java.lang.Exception
  - channelRead
```
public void channelRead(ChannelHandlerContext ctx,
                        java.lang.Object msg)
                 throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelRead(Object)转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelRead在界面 ChannelInboundHandler
    
    重写：
    
    channelRead在课堂上 AbstractTrafficShapingHandler
    
    异常
    
    java.lang.Exception
  - checkWaitReadTime
```
protected long checkWaitReadTime(ChannelHandlerContext ctx,
                                 long wait,
                                 long now)
```
    从类复制的描述： AbstractTrafficShapingHandler
    
    在GTSH中覆盖的方法考虑到通道的特定定时器。
    
    wait - 以毫秒计算的等待延迟
    
    now - 现在的相对时间，以毫秒为单位
    
    结果
    
    根据上下文使用等待
  - informReadOperation
```
protected void informReadOperation(ChannelHandlerContext ctx,
                                   long now)
```
    从类复制的描述： AbstractTrafficShapingHandler
    
    在GTSH中覆盖的方法考虑到通道的特定定时器。
    
    now - 现在的相对时间，以毫秒为单位
  - maximumCumulativeWrittenBytes
```
protected long maximumCumulativeWrittenBytes()
```
  - maximumCumulativeReadBytes
```
protected long maximumCumulativeReadBytes()
```
  - channelTrafficCounters
```
public java.util.Collection<TrafficCounter> channelTrafficCounters()
```
    例如，允许doAccounting使用每个频道的TrafficCounter。
    
    结果
    
    在通话时存在的TrafficCounters列表。
  - write
```
public void write(ChannelHandlerContext ctx,
                  java.lang.Object msg,
                  ChannelPromise promise)
           throws java.lang.Exception
```
    从类复制的描述： ChannelDuplexHandler
    
    致电ChannelOutboundInvoker.write(Object, ChannelPromise)转发到ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    write ，界面 ChannelOutboundHandler
    
    重写：
    
    write在课堂上 AbstractTrafficShapingHandler
    
    参数
    
    ctx - 进行写入操作的ChannelHandlerContext
    
    msg - 要写的消息
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - submitWrite
```
protected void submitWrite(ChannelHandlerContext ctx,
                           java.lang.Object msg,
                           long size,
                           long writedelay,
                           long now,
                           ChannelPromise promise)
```
  - toString
```
public java.lang.String toString()
```
    重写：
    
    toString在课堂上 AbstractTrafficShapingHandler

Class GlobalChannelTrafficShapingHandler

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

Field Summary

Fields inherited from class io.netty.handler.traffic.AbstractTrafficShapingHandler

构造方法摘要

方法摘要

Methods inherited from class io.netty.handler.traffic.AbstractTrafficShapingHandler

Methods inherited from class io.netty.channel.ChannelDuplexHandler

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.ChannelHandler

构造方法详细信息

GlobalChannelTrafficShapingHandler

GlobalChannelTrafficShapingHandler

GlobalChannelTrafficShapingHandler

GlobalChannelTrafficShapingHandler

GlobalChannelTrafficShapingHandler

方法详细信息

userDefinedWritabilityIndex

maxDeviation

accelerationFactor

slowDownFactor

setMaxDeviation

doAccounting

getMaxGlobalWriteSize

setMaxGlobalWriteSize

queuesSize

configureChannel

getWriteChannelLimit

setWriteChannelLimit

getReadChannelLimit

setReadChannelLimit

release

handlerAdded

handlerRemoved

channelRead

checkWaitReadTime

informReadOperation

maximumCumulativeWrittenBytes

maximumCumulativeReadBytes

channelTrafficCounters

write

submitWrite

toString