io.netty.handler.traffic

类 AbstractTrafficShapingHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.handler.traffic.AbstractTrafficShapingHandler

所有已实现的接口:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

直接已知子类:

ChannelTrafficShapingHandler, GlobalChannelTrafficShapingHandler, GlobalTrafficShapingHandler

public abstract class AbstractTrafficShapingHandler
extends ChannelDuplexHandler

AbstractTrafficShapingHandler allows to limit the global bandwidth (see GlobalTrafficShapingHandler) or per session bandwidth (see ChannelTrafficShapingHandler), as traffic shaping. It allows you 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.

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.

嵌套类概要

从接口继承的嵌套类/接口 io.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 TrafficCounter	trafficCounter Traffic Counter

构造器概要

构造器

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

方法概要

限定符和类型	方法和说明
protected long	calculateSize(java.lang.Object msg) Calculate the size of the given Object.
void	channelRead(ChannelHandlerContext ctx, java.lang.Object msg) Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelRegistered(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
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()
long	getWriteLimit()
void	handlerRemoved(ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.
protected static boolean	isHandlerActive(ChannelHandlerContext ctx)
void	read(ChannelHandlerContext ctx) Calls ChannelHandlerContext.read() to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	setCheckInterval(long checkInterval)
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 that this limit is a best effort on memory limitation to prevent Out Of Memory Exception.
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, java.lang.Object msg, long delay, ChannelPromise promise) 已过时。
java.lang.String	toString()
TrafficCounter	trafficCounter()
protected int	userDefinedWritabilityIndex()
void	write(ChannelHandlerContext ctx, java.lang.Object msg, ChannelPromise promise) Calls ChannelOutboundInvoker.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.

从类继承的方法 io.netty.channel.ChannelDuplexHandler

bind, close, connect, deregister, disconnect, flush

从类继承的方法 io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

从类继承的方法 io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, isSharable

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 io.netty.channel.ChannelHandler

exceptionCaught, handlerAdded

字段详细资料

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

maxTime

protected volatile long maxTime

Max delay in wait

checkInterval

protected volatile long checkInterval

Delay between two performance snapshots

构造器详细资料

AbstractTrafficShapingHandler

protected AbstractTrafficShapingHandler(long writeLimit,
                                        long readLimit,
                                        long checkInterval,
                                        long maxTime)

参数:

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 maximum delay to wait in case of traffic excess. Must be positive.

AbstractTrafficShapingHandler

protected AbstractTrafficShapingHandler(long writeLimit,
                                        long readLimit,
                                        long checkInterval)

Constructor using default max time as delay allowed value of 15000L ms.

参数:

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(long writeLimit,
                                        long readLimit)

Constructor using default Check Interval value of 1000L ms and default max time as delay allowed value of 15000L ms.

参数:

writeLimit - 0 or a limit in bytes/s

readLimit - 0 or a limit in bytes/s

AbstractTrafficShapingHandler

protected AbstractTrafficShapingHandler()

Constructor using NO LIMIT, default Check Interval value of 1000L ms and default max time as delay allowed value of 15000L ms.

AbstractTrafficShapingHandler

protected AbstractTrafficShapingHandler(long checkInterval)

Constructor using NO LIMIT and default max time as delay allowed value of 15000L ms.

参数:

checkInterval - The delay between two computations of performances for channels or 0 if no stats are to be computed.

方法详细资料

userDefinedWritabilityIndex

protected int userDefinedWritabilityIndex()

返回:

the index to be used by the TrafficShapingHandler to manage the user defined writability. For Channel TSH it is defined as , for Global TSH it is defined as , for GlobalChannel TSH it is defined as .

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.

参数:

newCheckInterval - The new check interval (in milliseconds)

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 checkInterval)

参数:

checkInterval - the interval in ms between each step check to set, default value being 1000 ms.

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.

getMaxTimeWait

public long getMaxTimeWait()

返回:

the max delay in wait to prevent TIME OUT

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 suspension is set. Must be positive.

getMaxWriteSize

public long getMaxWriteSize()

返回:

the maxWriteSize default being bytes.

setMaxWriteSize

public void setMaxWriteSize(long maxWriteSize)

Note that this limit is a best effort on memory limitation to prevent Out Of Memory Exception. To ensure it works, the handler generating the write should use one of the way provided by Netty to handle the capacity:

- the Channel.isWritable() property and the corresponding channelWritabilityChanged()

- the ChannelFuture.addListener(new GenericFutureListener())

参数:

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

channelRead

public void channelRead(ChannelHandlerContext ctx,
                        java.lang.Object msg)
                 throws java.lang.Exception

从类复制的说明: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

channelRead 在接口中 ChannelInboundHandler

覆盖:

channelRead 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception

handlerRemoved

public void handlerRemoved(ChannelHandlerContext ctx)
                    throws java.lang.Exception

从类复制的说明: ChannelHandlerAdapter

Do nothing by default, sub-classes may override this method.

指定者:

handlerRemoved 在接口中 ChannelHandler

覆盖:

handlerRemoved 在类中 ChannelHandlerAdapter

抛出:

java.lang.Exception

isHandlerActive

protected static boolean isHandlerActive(ChannelHandlerContext ctx)

read

public void read(ChannelHandlerContext ctx)

从类复制的说明: ChannelDuplexHandler

Calls ChannelHandlerContext.read() to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

read 在接口中 ChannelOutboundHandler

覆盖:

read 在类中 ChannelDuplexHandler

write

public void write(ChannelHandlerContext ctx,
                  java.lang.Object msg,
                  ChannelPromise promise)
           throws java.lang.Exception

从类复制的说明: ChannelDuplexHandler

Calls ChannelOutboundInvoker.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

write 在接口中 ChannelOutboundHandler

覆盖:

write 在类中 ChannelDuplexHandler

参数:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

promise - the ChannelPromise to notify once the operation completes

抛出:

java.lang.Exception - thrown if an error occurs

submitWrite

@Deprecated
protected void submitWrite(ChannelHandlerContext ctx,
                                        java.lang.Object msg,
                                        long delay,
                                        ChannelPromise promise)

已过时。

channelRegistered

public void channelRegistered(ChannelHandlerContext ctx)
                       throws java.lang.Exception

从类复制的说明: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

channelRegistered 在接口中 ChannelInboundHandler

覆盖:

channelRegistered 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception

trafficCounter

public TrafficCounter trafficCounter()

返回:

the current TrafficCounter (if channel is still connected)

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object

calculateSize

protected long calculateSize(java.lang.Object msg)

Calculate the size of the given Object. This implementation supports ByteBuf, ByteBufHolder and FileRegion. Sub-classes may override this.

参数:

msg - the msg for which the size should be calculated.

返回:

size the size of the msg or -1 if unknown.