Top Description Inners Fields Constructors Methods

io.netty.handler.traffic

public Class ChannelTrafficShapingHandler

Class Inheritance

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

Imports

io.netty.buffer.ByteBuf, io.netty.channel.ChannelHandlerContext, .ChannelPromise, java.util.ArrayDeque, java.util.concurrent.TimeUnit

This implementation of the AbstractTrafficShapingHandler is for channel traffic shaping, that is to say a per channel limitation of the bandwidth.

Note the index used in OutboundBuffer.setUserDefinedWritability(index, boolean) is 1.

The general use should be as follow:

Add in your pipeline a new ChannelTrafficShapingHandler.

ChannelTrafficShapingHandler myHandler = new ChannelTrafficShapingHandler();

pipeline.addLast(myHandler);

Note that this handler has a Pipeline Coverage of "one" which means a new handler must be created for each new channel as the counter cannot be shared among all channels..

Other arguments can be passed like write or read limitation (in bytes/s where 0 means no limitation) or the check interval (in millisecond) that represents the delay between two computations of the bandwidth and so the call back of the doAccounting method (0 means no accounting at all).

A value of 0 means no accounting for checkInterval. If you need traffic shaping but no such accounting, it is recommended to set a positive value, even if it is high since the precision of the Traffic Shaping depends on the period where the traffic is computed. The highest the interval, the less precise the traffic shaping will be. It is suggested as higher value something close to 5 or 10 minutes.

maxTimeToWait, by default set to 15s, allows to specify an upper bound of time shaping.
In your handler, you should consider to use the channel.isWritable() and channelWritabilityChanged(ctx) to handle writability, or through future.addListener(new GenericFutureListener()) on the future returned by ctx.write().
You shall also consider to have object size in read or write operations relatively adapted to the bandwidth you required: for instance having 10 MB objects for 10KB/s will lead to burst effect, while having 100 KB objects for 1 MB/s should be smoothly handle by this TrafficShaping handler.
Some configuration methods 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 those methods are to be used not too often, accordingly to the traffic shaping configuration.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	ChannelTrafficShapingHandler.ToSend

Field Summary

Modifier and Type	Field and Description
private final ArrayDeque<ChannelTrafficShapingHandler.ToSend>	messagesQueue
private long	queueSize

Inherited from io.netty.handler.traffic.AbstractTrafficShapingHandler:: CHANNEL_DEFAULT_USER_DEFINED_WRITABILITY_INDEX checkInterval DEFAULT_CHECK_INTERVAL DEFAULT_MAX_SIZE DEFAULT_MAX_TIME GLOBAL_DEFAULT_USER_DEFINED_WRITABILITY_INDEX GLOBALCHANNEL_DEFAULT_USER_DEFINED_WRITABILITY_INDEX maxTime maxWriteDelay maxWriteSize MINIMAL_WAIT READ_SUSPENDED REOPEN_TASK trafficCounter userDefinedWritabilityIndex

Constructor Summary

Access	Constructor and Description
public	ChannelTrafficShapingHandler(long 0 or a limit in bytes/s writeLimit, long 0 or a limit in bytes/s readLimit, long The delay between two computations of performances for channels or 0 if no stats are to be computed. checkInterval, long The maximum delay to wait in case of traffic excess. maxTime) Create a new instance.
public	ChannelTrafficShapingHandler(long 0 or a limit in bytes/s writeLimit, long 0 or a limit in bytes/s readLimit, long The delay between two computations of performances for channels or 0 if no stats are to be computed. checkInterval) Create a new instance using default max time as delay allowed value of 15000 ms.
public	ChannelTrafficShapingHandler(long 0 or a limit in bytes/s writeLimit, long 0 or a limit in bytes/s readLimit) Create a new instance using default Check Interval value of 1000 ms and max time as delay allowed value of 15000 ms.
public	ChannelTrafficShapingHandler(long The delay between two computations of performances for channels or 0 if no stats are to be computed. checkInterval) Create a new instance using default max time as delay allowed value of 15000 ms and no limit.

Method Summary

Modifier and Type	Method and Description
public void	handlerAdded(ChannelHandlerContext ctx) Overrides io.netty.channel.ChannelHandlerAdapter.handlerAdded. Implements io.netty.channel.ChannelHandler.handlerAdded. Gets called after the `ChannelHandler` was added to the actual context and it's ready to handle events.
public void	handlerRemoved(ChannelHandlerContext ctx) Overrides io.netty.handler.traffic.AbstractTrafficShapingHandler.handlerRemoved. Implements io.netty.channel.ChannelHandler.handlerRemoved. Gets called after the `ChannelHandler` was removed from the actual context and it doesn't handle events anymore.
public long	Returns: current size in bytes of the write buffer. queueSize()
private void	sendAllValid(final ChannelHandlerContext ctx, final long now)
pack-priv void	submitWrite(final ChannelHandlerContext ctx, final Object msg, final long size, final long delay, final long now, final ChannelPromise promise) Implements abstract io.netty.handler.traffic.AbstractTrafficShapingHandler.submitWrite.

Field Detail

messagesQueue	back to summary
private final ArrayDeque<ChannelTrafficShapingHandler.ToSend> messagesQueue

queueSize	back to summary
private long queueSize

Constructor Detail

ChannelTrafficShapingHandler	back to summary
public ChannelTrafficShapingHandler(long writeLimit, long readLimit, long checkInterval, long maxTime) Create a new instance. Parameters writeLimit:long 0 or a limit in bytes/s readLimit:long 0 or a limit in bytes/s checkInterval:long The delay between two computations of performances for channels or 0 if no stats are to be computed. maxTime:long The maximum delay to wait in case of traffic excess.

ChannelTrafficShapingHandler

back to summary

public ChannelTrafficShapingHandler(long writeLimit, long readLimit, long checkInterval, long maxTime)

Create a new instance.

Parameters

writeLimit:long: 0 or a limit in bytes/s
readLimit:long: 0 or a limit in bytes/s
checkInterval:long: The delay between two computations of performances for channels or 0 if no stats are to be computed.
maxTime:long: The maximum delay to wait in case of traffic excess.

ChannelTrafficShapingHandler	back to summary
public ChannelTrafficShapingHandler(long writeLimit, long readLimit, long checkInterval) Create a new instance using default max time as delay allowed value of 15000 ms. Parameters writeLimit:long 0 or a limit in bytes/s readLimit:long 0 or a limit in bytes/s checkInterval:long The delay between two computations of performances for channels or 0 if no stats are to be computed.

ChannelTrafficShapingHandler

back to summary

public ChannelTrafficShapingHandler(long writeLimit, long readLimit, long checkInterval)

Create a new instance using default max time as delay allowed value of 15000 ms.

Parameters

writeLimit:long: 0 or a limit in bytes/s
readLimit:long: 0 or a limit in bytes/s
checkInterval:long: The delay between two computations of performances for channels or 0 if no stats are to be computed.

ChannelTrafficShapingHandler	back to summary
public ChannelTrafficShapingHandler(long writeLimit, long readLimit) Create a new instance using default Check Interval value of 1000 ms and max time as delay allowed value of 15000 ms. Parameters writeLimit:long 0 or a limit in bytes/s readLimit:long 0 or a limit in bytes/s

ChannelTrafficShapingHandler

back to summary

public ChannelTrafficShapingHandler(long writeLimit, long readLimit)

Create a new instance using default Check Interval value of 1000 ms and max time as delay allowed value of 15000 ms.

Parameters

writeLimit:long: 0 or a limit in bytes/s
readLimit:long: 0 or a limit in bytes/s

ChannelTrafficShapingHandler	back to summary
public ChannelTrafficShapingHandler(long checkInterval) Create a new instance using default max time as delay allowed value of 15000 ms and no limit. Parameters checkInterval:long The delay between two computations of performances for channels or 0 if no stats are to be computed.

ChannelTrafficShapingHandler

back to summary

public ChannelTrafficShapingHandler(long checkInterval)

Create a new instance using default max time as delay allowed value of 15000 ms and no limit.

Parameters

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

Method Detail

handlerAdded back to summary

handlerAdded	back to summary
public void handlerAdded(ChannelHandlerContext ctx) throws Exception Overrides io.netty.channel.ChannelHandlerAdapter.handlerAdded. Implements io.netty.channel.ChannelHandler.handlerAdded. Doc from io.netty.channel.ChannelHandler.handlerAdded. Gets called after the `ChannelHandler` was added to the actual context and it's ready to handle events. Annotations @Override

public void handlerAdded(ChannelHandlerContext ctx) throws Exception

Overrides io.netty.channel.ChannelHandlerAdapter.handlerAdded.

Implements io.netty.channel.ChannelHandler.handlerAdded.

Doc from io.netty.channel.ChannelHandler.handlerAdded.

Gets called after the ChannelHandler was added to the actual context and it's ready to handle events.

Annotations

@Override

handlerRemoved back to summary

handlerRemoved	back to summary
public void handlerRemoved(ChannelHandlerContext ctx) throws Exception Overrides io.netty.handler.traffic.AbstractTrafficShapingHandler.handlerRemoved. Implements io.netty.channel.ChannelHandler.handlerRemoved. Doc from io.netty.channel.ChannelHandler.handlerRemoved. Gets called after the `ChannelHandler` was removed from the actual context and it doesn't handle events anymore. Annotations @Override

public void handlerRemoved(ChannelHandlerContext ctx) throws Exception

Overrides io.netty.handler.traffic.AbstractTrafficShapingHandler.handlerRemoved.

Implements io.netty.channel.ChannelHandler.handlerRemoved.

Doc from io.netty.channel.ChannelHandler.handlerRemoved.

Gets called after the ChannelHandler was removed from the actual context and it doesn't handle events anymore.

Annotations

@Override

queueSize	back to summary
public long queueSize() Returns:long current size in bytes of the write buffer.

sendAllValid	back to summary
private void sendAllValid(final ChannelHandlerContext ctx, final long now)

submitWrite	back to summary
pack-priv void submitWrite(final ChannelHandlerContext ctx, final Object msg, final long size, final long delay, final long now, final ChannelPromise promise) Implements abstract io.netty.handler.traffic.AbstractTrafficShapingHandler.submitWrite. Annotations @Override

submitWrite

back to summary

pack-priv void submitWrite(final ChannelHandlerContext ctx, final Object msg, final long size, final long delay, final long now, final ChannelPromise promise)

Implements abstract io.netty.handler.traffic.AbstractTrafficShapingHandler.submitWrite.

Annotations

@Override

io.netty.handler.traffic back to summary

private final Class ChannelTrafficShapingHandler.ToSend

Class Inheritance

extends Object

java.lang.Object
io.netty.handler.traffic.ChannelTrafficShapingHandler.ToSend

Field Summary

Modifier and Type	Field and Description
pack-priv final ChannelPromise	promise
pack-priv final long	relativeTimeAction
pack-priv final Object	toSend

Constructor Summary

Access	Constructor and Description
private	ToSend(final long delay, final Object toSend, final ChannelPromise promise)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

promise	back to summary
pack-priv final ChannelPromise promise

relativeTimeAction	back to summary
pack-priv final long relativeTimeAction

toSend	back to summary
pack-priv final Object toSend

Constructor Detail

ToSend	back to summary
private ToSend(final long delay, final Object toSend, final ChannelPromise promise)