io.netty.handler.traffic

Class GlobalTrafficShapingHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.handler.traffic.AbstractTrafficShapingHandler

io.netty.handler.traffic.GlobalTrafficShapingHandler

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

@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.

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.
  

Be sure to call 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.

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 Summary

Constructors

Constructor and Description
GlobalTrafficShapingHandler(EventExecutor executor) Create a new instance
GlobalTrafficShapingHandler(ScheduledExecutorService executor, long checkInterval) Create a new instance
GlobalTrafficShapingHandler(ScheduledExecutorService executor, long writeLimit, long readLimit) Create a new instance
GlobalTrafficShapingHandler(ScheduledExecutorService executor, long writeLimit, long readLimit, long checkInterval) Create a new instance
GlobalTrafficShapingHandler(ScheduledExecutorService executor, long writeLimit, long readLimit, long checkInterval, long maxTime) Create a new instance

Method Summary

Methods

Modifier and Type	Method and Description
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.
void	release() Release all internal resources of this instance
protected void	submitWrite(ChannelHandlerContext ctx, Object msg, long delay, ChannelPromise promise)

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

calculateSize, channelRead, configure, configure, configure, doAccounting, getCheckInterval, getMaxTimeWait, getReadLimit, getWriteLimit, isHandlerActive, read, setCheckInterval, setMaxTimeWait, setReadLimit, setWriteLimit, toString, trafficCounter, write

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, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

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

Constructor Detail

GlobalTrafficShapingHandler

public GlobalTrafficShapingHandler(ScheduledExecutorService executor,
                           long writeLimit,
                           long readLimit,
                           long checkInterval,
                           long maxTime)

Create a new instance

Parameters:

executor - the ScheduledExecutorService to use for the TrafficCounter

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

GlobalTrafficShapingHandler

public GlobalTrafficShapingHandler(ScheduledExecutorService executor,
                           long writeLimit,
                           long readLimit,
                           long checkInterval)

Create a new instance

Parameters:

executor - the ScheduledExecutorService to use for the TrafficCounter

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

GlobalTrafficShapingHandler

public GlobalTrafficShapingHandler(ScheduledExecutorService executor,
                           long writeLimit,
                           long readLimit)

Create a new instance

Parameters:

executor - the ScheduledExecutorService to use for the TrafficCounter

writeLimit - 0 or a limit in bytes/s

readLimit - 0 or a limit in bytes/s

GlobalTrafficShapingHandler

public GlobalTrafficShapingHandler(ScheduledExecutorService executor,
                           long checkInterval)

Create a new instance

Parameters:

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

GlobalTrafficShapingHandler

public GlobalTrafficShapingHandler(EventExecutor executor)

Create a new instance

Parameters:

executor - the ScheduledExecutorService to use for the TrafficCounter

Method Detail

release

public final void release()

Release all internal resources of this instance

handlerAdded

public void handlerAdded(ChannelHandlerContext ctx)
                  throws Exception

Description copied from class: ChannelHandlerAdapter

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

Specified by:

handlerAdded in interface ChannelHandler

Overrides:

handlerAdded in class ChannelHandlerAdapter

Throws:

Exception

handlerRemoved

public void handlerRemoved(ChannelHandlerContext ctx)
                    throws Exception

Description copied from class: ChannelHandlerAdapter

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

Specified by:

handlerRemoved in interface ChannelHandler

Overrides:

handlerRemoved in class ChannelHandlerAdapter

Throws:

Exception

submitWrite

protected void submitWrite(ChannelHandlerContext ctx,
               Object msg,
               long delay,
               ChannelPromise promise)

Specified by:

submitWrite in class AbstractTrafficShapingHandler