@ChannelHandler.Sharable public class GlobalTrafficShapingHandler extends AbstractTrafficShapingHandler
This implementation of the AbstractTrafficShapingHandler
is for global
traffic shaping, that is to say a global limitation of the bandwidth, whatever
the number of opened channels.
Note the index used in OutboundBuffer.setUserDefinedWritability(index, boolean)
is 2.
The general use should be as follow:
Create your unique GlobalTrafficShapingHandler like:
GlobalTrafficShapingHandler myHandler = new GlobalTrafficShapingHandler(executor);
The executor could be the underlying IO worker pool
pipeline.addLast(myHandler);
Note that this handler has a Pipeline Coverage of "all" which means only one such handler must be created and shared among all channels as the counter must 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.
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.release()
once this handler is not needed anymore to release all internal resources.
This will not shutdown the EventExecutor
as it may be shared, so you need to do this by your own.Modifier and Type | Class and Description |
---|---|
private static class |
GlobalTrafficShapingHandler.PerChannel |
private static class |
GlobalTrafficShapingHandler.ToSend |
AbstractTrafficShapingHandler.ReopenReadTimerTask
ChannelHandler.Sharable
Modifier and Type | Field and Description |
---|---|
private java.util.concurrent.ConcurrentMap<java.lang.Integer,GlobalTrafficShapingHandler.PerChannel> |
channelQueues
All queues per channel
|
(package private) long |
maxGlobalWriteSize
Max size in the list before proposing to stop writing new objects from next handlers
for all channel (global)
|
private java.util.concurrent.atomic.AtomicLong |
queuesSize
Global queues size
|
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 and Description |
---|
GlobalTrafficShapingHandler(EventExecutor executor)
Create a new instance using default Check Interval value of 1000 ms and
default max time as delay allowed value of 15000 ms and no limit.
|
GlobalTrafficShapingHandler(java.util.concurrent.ScheduledExecutorService executor,
long checkInterval)
Create a new instance using
default max time as delay allowed value of 15000 ms and no limit.
|
GlobalTrafficShapingHandler(java.util.concurrent.ScheduledExecutorService executor,
long writeLimit,
long readLimit)
Create a new instance using default Check Interval value of 1000 ms and
default max time as delay allowed value of 15000 ms.
|
GlobalTrafficShapingHandler(java.util.concurrent.ScheduledExecutorService executor,
long writeLimit,
long readLimit,
long checkInterval)
Create a new instance using
default max time as delay allowed value of 15000 ms.
|
GlobalTrafficShapingHandler(java.util.concurrent.ScheduledExecutorService executor,
long writeLimit,
long readLimit,
long checkInterval,
long maxTime)
Create a new instance.
|
Modifier and Type | Method and Description |
---|---|
(package private) long |
checkWaitReadTime(ChannelHandlerContext ctx,
long wait,
long now)
Method overridden in GTSH to take into account specific timer for the channel.
|
(package private) void |
createGlobalTrafficCounter(java.util.concurrent.ScheduledExecutorService executor)
Create the global TrafficCounter.
|
long |
getMaxGlobalWriteSize() |
private GlobalTrafficShapingHandler.PerChannel |
getOrSetPerChannel(ChannelHandlerContext ctx) |
void |
handlerAdded(ChannelHandlerContext ctx)
Do nothing by default, sub-classes may override this method.
|
void |
handlerRemoved(ChannelHandlerContext ctx)
Do nothing by default, sub-classes may override this method.
|
(package private) void |
informReadOperation(ChannelHandlerContext ctx,
long now)
Method overridden in GTSH to take into account specific timer for the channel.
|
long |
queuesSize() |
void |
release()
Release all internal resources of this instance.
|
private void |
sendAllValid(ChannelHandlerContext ctx,
GlobalTrafficShapingHandler.PerChannel perChannel,
long now) |
void |
setMaxGlobalWriteSize(long maxGlobalWriteSize)
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. |
(package private) void |
submitWrite(ChannelHandlerContext ctx,
java.lang.Object msg,
long size,
long writedelay,
long now,
ChannelPromise promise) |
calculateSize, channelRead, channelRegistered, checkWriteSuspend, configure, configure, configure, doAccounting, getCheckInterval, getMaxTimeWait, getMaxWriteDelay, getMaxWriteSize, getReadLimit, getWriteLimit, isHandlerActive, read, releaseReadSuspended, releaseWriteSuspended, setCheckInterval, setMaxTimeWait, setMaxWriteDelay, setMaxWriteSize, setReadLimit, setTrafficCounter, setUserDefinedWritability, setWriteLimit, submitWrite, toString, trafficCounter, userDefinedWritabilityIndex, write
bind, close, connect, deregister, disconnect, flush
channelActive, channelInactive, channelReadComplete, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered
isSharable
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
exceptionCaught
private final java.util.concurrent.ConcurrentMap<java.lang.Integer,GlobalTrafficShapingHandler.PerChannel> channelQueues
private final java.util.concurrent.atomic.AtomicLong queuesSize
long maxGlobalWriteSize
public GlobalTrafficShapingHandler(java.util.concurrent.ScheduledExecutorService executor, long writeLimit, long readLimit, long checkInterval, long maxTime)
executor
- the ScheduledExecutorService
to use for the TrafficCounter
.writeLimit
- 0 or a limit in bytes/sreadLimit
- 0 or a limit in bytes/scheckInterval
- 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.public GlobalTrafficShapingHandler(java.util.concurrent.ScheduledExecutorService executor, long writeLimit, long readLimit, long checkInterval)
executor
- the ScheduledExecutorService
to use for the TrafficCounter
.writeLimit
- 0 or a limit in bytes/sreadLimit
- 0 or a limit in bytes/scheckInterval
- The delay between two computations of performances for
channels or 0 if no stats are to be computed.public GlobalTrafficShapingHandler(java.util.concurrent.ScheduledExecutorService executor, long writeLimit, long readLimit)
executor
- the ScheduledExecutorService
to use for the TrafficCounter
.writeLimit
- 0 or a limit in bytes/sreadLimit
- 0 or a limit in bytes/spublic GlobalTrafficShapingHandler(java.util.concurrent.ScheduledExecutorService executor, long checkInterval)
executor
- the ScheduledExecutorService
to use for the TrafficCounter
.checkInterval
- The delay between two computations of performances for
channels or 0 if no stats are to be computed.public GlobalTrafficShapingHandler(EventExecutor executor)
executor
- the ScheduledExecutorService
to use for the TrafficCounter
.void createGlobalTrafficCounter(java.util.concurrent.ScheduledExecutorService executor)
public long getMaxGlobalWriteSize()
public void setMaxGlobalWriteSize(long maxGlobalWriteSize)
maxGlobalWriteSize
- the maximum Global Write Size allowed in the buffer
globally for all channels before write suspended is set,
default value being 400 MB.public long queuesSize()
public final void release()
private GlobalTrafficShapingHandler.PerChannel getOrSetPerChannel(ChannelHandlerContext ctx)
public void handlerAdded(ChannelHandlerContext ctx) throws java.lang.Exception
ChannelHandlerAdapter
handlerAdded
in interface ChannelHandler
handlerAdded
in class ChannelHandlerAdapter
java.lang.Exception
public void handlerRemoved(ChannelHandlerContext ctx) throws java.lang.Exception
ChannelHandlerAdapter
handlerRemoved
in interface ChannelHandler
handlerRemoved
in class ChannelHandlerAdapter
java.lang.Exception
long checkWaitReadTime(ChannelHandlerContext ctx, long wait, long now)
AbstractTrafficShapingHandler
checkWaitReadTime
in class AbstractTrafficShapingHandler
wait
- the wait delay computed in msnow
- the relative now time in msvoid informReadOperation(ChannelHandlerContext ctx, long now)
AbstractTrafficShapingHandler
informReadOperation
in class AbstractTrafficShapingHandler
now
- the relative now time in msvoid submitWrite(ChannelHandlerContext ctx, java.lang.Object msg, long size, long writedelay, long now, ChannelPromise promise)
submitWrite
in class AbstractTrafficShapingHandler
private void sendAllValid(ChannelHandlerContext ctx, GlobalTrafficShapingHandler.PerChannel perChannel, long now)