org.jboss.netty.handler.traffic

Class GlobalTrafficShapingHandler

java.lang.Object

org.jboss.netty.channel.SimpleChannelHandler

org.jboss.netty.handler.traffic.AbstractTrafficShapingHandler

org.jboss.netty.handler.traffic.GlobalTrafficShapingHandler

All Implemented Interfaces:

ChannelDownstreamHandler, ChannelHandler, ChannelUpstreamHandler, ExternalResourceReleasable

@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(timer);

  timer could be created using HashedWheelTimer

  pipeline.addLast("GLOBAL_TRAFFIC_SHAPING", 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.

• Add it in your pipeline, before a recommended ExecutionHandler (like OrderedMemoryAwareThreadPoolExecutor or MemoryAwareThreadPoolExecutor).

  pipeline.addLast("GLOBAL_TRAFFIC_SHAPING", myHandler);

• When you shutdown your application, release all the external resources by calling:

  myHandler.releaseExternalResources();

Nested Class Summary

Nested classes/interfaces inherited from class org.jboss.netty.handler.traffic.AbstractTrafficShapingHandler

AbstractTrafficShapingHandler.SimpleObjectSizeEstimator

Nested classes/interfaces inherited from interface org.jboss.netty.channel.ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields inherited from class org.jboss.netty.handler.traffic.AbstractTrafficShapingHandler

checkInterval, DEFAULT_CHECK_INTERVAL, DEFAULT_MAX_TIME, maxTime, timer, trafficCounter

Constructor Summary

Constructors

Constructor and Description
GlobalTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer)
GlobalTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer, long checkInterval)
GlobalTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer, long writeLimit, long readLimit)
GlobalTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer, long writeLimit, long readLimit, long checkInterval)
GlobalTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer, long writeLimit, long readLimit, long checkInterval, long maxTime)
GlobalTrafficShapingHandler(Timer timer)
GlobalTrafficShapingHandler(Timer timer, long checkInterval)
GlobalTrafficShapingHandler(Timer timer, long writeLimit, long readLimit)
GlobalTrafficShapingHandler(Timer timer, long writeLimit, long readLimit, long checkInterval)
GlobalTrafficShapingHandler(Timer timer, long writeLimit, long readLimit, long checkInterval, long maxTime)

Method Summary

Methods

Modifier and Type	Method and Description
void	channelClosed(ChannelHandlerContext ctx, ChannelStateEvent e) Invoked when a Channel was closed and all its related resources were released.
void	channelConnected(ChannelHandlerContext ctx, ChannelStateEvent e) Invoked when a Channel is open, bound to a local address, and connected to a remote address.
long	getMaxGlobalWriteSize()
long	queuesSize()
void	releaseExternalResources() Releases the external resources that this object depends on.
void	setMaxGlobalWriteSize(long maxGlobalWriteSize)

Methods inherited from class org.jboss.netty.handler.traffic.AbstractTrafficShapingHandler

calculateSize, configure, configure, configure, doAccounting, getCheckInterval, getMaxTimeWait, getMaxWriteDelay, getMaxWriteSize, getReadLimit, getTrafficCounter, getWriteLimit, internalSubmitWrite, messageReceived, setCheckInterval, setMaxTimeWait, setMaxWriteDelay, setMaxWriteSize, setReadLimit, setWriteLimit, submitWrite, toString, writeRequested

Methods inherited from class org.jboss.netty.channel.SimpleChannelHandler

bindRequested, channelBound, channelDisconnected, channelInterestChanged, channelOpen, channelUnbound, childChannelClosed, childChannelOpen, closeRequested, connectRequested, disconnectRequested, exceptionCaught, handleDownstream, handleUpstream, setInterestOpsRequested, unbindRequested, writeComplete

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobalTrafficShapingHandler

public GlobalTrafficShapingHandler(Timer timer,
                           long writeLimit,
                           long readLimit,
                           long checkInterval)

GlobalTrafficShapingHandler

public GlobalTrafficShapingHandler(Timer timer,
                           long writeLimit,
                           long readLimit,
                           long checkInterval,
                           long maxTime)

GlobalTrafficShapingHandler

public GlobalTrafficShapingHandler(Timer timer,
                           long writeLimit,
                           long readLimit)

GlobalTrafficShapingHandler

public GlobalTrafficShapingHandler(Timer timer,
                           long checkInterval)

GlobalTrafficShapingHandler

public GlobalTrafficShapingHandler(Timer timer)

GlobalTrafficShapingHandler

public GlobalTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator,
                           Timer timer,
                           long writeLimit,
                           long readLimit,
                           long checkInterval)

GlobalTrafficShapingHandler

public GlobalTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator,
                           Timer timer,
                           long writeLimit,
                           long readLimit,
                           long checkInterval,
                           long maxTime)

GlobalTrafficShapingHandler

public GlobalTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator,
                           Timer timer,
                           long writeLimit,
                           long readLimit)

GlobalTrafficShapingHandler

public GlobalTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator,
                           Timer timer,
                           long checkInterval)

GlobalTrafficShapingHandler

public GlobalTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator,
                           Timer timer)

Method Detail

getMaxGlobalWriteSize

public long getMaxGlobalWriteSize()

Returns:

the maxGlobalWriteSize default value being 400 MB.

setMaxGlobalWriteSize

public void setMaxGlobalWriteSize(long maxGlobalWriteSize)

Parameters:

maxGlobalWriteSize - the maximum Global Write Size allowed in the buffer globally for all channels before write suspended is set, default value being 400 MB.

queuesSize

public long queuesSize()

Returns:

the global size of the buffers for all queues.

channelConnected

public void channelConnected(ChannelHandlerContext ctx,
                    ChannelStateEvent e)
                      throws Exception

Description copied from class: SimpleChannelHandler

Invoked when a Channel is open, bound to a local address, and connected to a remote address.

Overrides:

channelConnected in class AbstractTrafficShapingHandler

Throws:

Exception

channelClosed

public void channelClosed(ChannelHandlerContext ctx,
                 ChannelStateEvent e)
                   throws Exception

Description copied from class: SimpleChannelHandler

Invoked when a Channel was closed and all its related resources were released.

Overrides:

channelClosed in class SimpleChannelHandler

Throws:

Exception

releaseExternalResources

public void releaseExternalResources()

Description copied from interface: ExternalResourceReleasable

Releases the external resources that this object depends on. You should not call this method if the external resources (e.g. thread pool) are in use by other objects.

Specified by:

releaseExternalResources in interface ExternalResourceReleasable

Overrides:

releaseExternalResources in class AbstractTrafficShapingHandler