org.jboss.netty.handler.traffic

Class GlobalChannelTrafficShapingHandler

java.lang.Object

org.jboss.netty.channel.SimpleChannelHandler

org.jboss.netty.handler.traffic.AbstractTrafficShapingHandler

org.jboss.netty.handler.traffic.GlobalChannelTrafficShapingHandler

All Implemented Interfaces:

ChannelDownstreamHandler, ChannelHandler, ChannelUpstreamHandler, ExternalResourceReleasable

@ChannelHandler.Sharable
public class GlobalChannelTrafficShapingHandler
extends AbstractTrafficShapingHandler

This implementation of the AbstractTrafficShapingHandler is for global and per channel traffic shaping, that is to say a global limitation of the bandwidth, whatever the number of opened channels and a per channel limitation of the bandwidth.

This version shall not be in the same pipeline than other TrafficShapingHandler.

The general use should be as follow:

• Create your unique GlobalChannelTrafficShapingHandler like:
  
  GlobalChannelTrafficShapingHandler myHandler = new GlobalChannelTrafficShapingHandler(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).
  Note that as this is a fusion of both Global and Channel Traffic Shaping, limits are in 2 sets, respectively Global and Channel.
  
  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.

Be sure to call release() once this handler is not needed anymore to release all internal resources. This will not shutdown the Timer as it may be shared, so you need to do this by your own.

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
GlobalChannelTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer)
GlobalChannelTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer, long checkInterval)
GlobalChannelTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer, long writeLimit, long readLimit, long writeChannelLimit, long readChannelLimit)
GlobalChannelTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer, long writeLimit, long readLimit, long writeChannelLimit, long readChannelLimit, long checkInterval)
GlobalChannelTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer, long writeLimit, long readLimit, long writeChannelLimit, long readChannelLimit, long checkInterval, long maxTime)
GlobalChannelTrafficShapingHandler(Timer timer) Create a new instance.
GlobalChannelTrafficShapingHandler(Timer timer, long checkInterval) Create a new instance.
GlobalChannelTrafficShapingHandler(Timer timer, long writeGlobalLimit, long readGlobalLimit, long writeChannelLimit, long readChannelLimit) Create a new instance.
GlobalChannelTrafficShapingHandler(Timer timer, long writeGlobalLimit, long readGlobalLimit, long writeChannelLimit, long readChannelLimit, long checkInterval) Create a new instance.
GlobalChannelTrafficShapingHandler(Timer timer, long writeGlobalLimit, long readGlobalLimit, long writeChannelLimit, long readChannelLimit, long checkInterval, long maxTime) Create a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
float	accelerationFactor()
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.
Collection<TrafficCounter>	channelTrafficCounters() To allow for instance doAccounting to use the TrafficCounter per channel.
protected long	checkWaitReadTime(ChannelHandlerContext ctx, long wait, long now) Method overridden in GTSH to take into account specific timer for the channel.
void	configureChannel(long newWriteLimit, long newReadLimit)
protected void	doAccounting(TrafficCounter counter) Called each time the accounting is computed from the TrafficCounters.
long	getMaxGlobalWriteSize()
long	getReadChannelLimit()
long	getWriteChannelLimit()
protected void	informReadOperation(ChannelHandlerContext ctx, long now) Method overridden in GTSH to take into account specific timer for the channel.
float	maxDeviation()
protected long	maximumCumulativeReadBytes()
protected long	maximumCumulativeWrittenBytes()
void	messageReceived(ChannelHandlerContext ctx, MessageEvent evt) Invoked when a message object (e.g: ChannelBuffer) was received from a remote peer.
long	queuesSize()
void	release() Release all internal resources of this instance.
void	setMaxDeviation(float maxDeviation, float slowDownFactor, float accelerationFactor)
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.
void	setReadChannelLimit(long readLimit)
void	setWriteChannelLimit(long writeLimit)
float	slowDownFactor()
protected void	submitWrite(ChannelHandlerContext ctx, MessageEvent evt, long size, long writedelay, long now)
String	toString()
void	writeRequested(ChannelHandlerContext ctx, MessageEvent evt) Invoked when Channel.write(Object) is called.

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

calculateSize, configure, configure, configure, getCheckInterval, getMaxTimeWait, getMaxWriteDelay, getMaxWriteSize, getReadLimit, getTrafficCounter, getWriteLimit, internalSubmitWrite, releaseExternalResources, setCheckInterval, setMaxTimeWait, setMaxWriteDelay, setMaxWriteSize, setReadLimit, setWriteLimit, submitWrite

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

GlobalChannelTrafficShapingHandler

public GlobalChannelTrafficShapingHandler(Timer timer,
                                  long writeGlobalLimit,
                                  long readGlobalLimit,
                                  long writeChannelLimit,
                                  long readChannelLimit,
                                  long checkInterval,
                                  long maxTime)

Create a new instance.

Parameters:

timer - the Timer to use for the TrafficCounter.

writeGlobalLimit - 0 or a limit in bytes/s

readGlobalLimit - 0 or a limit in bytes/s

writeChannelLimit - 0 or a limit in bytes/s

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

GlobalChannelTrafficShapingHandler

public GlobalChannelTrafficShapingHandler(Timer timer,
                                  long writeGlobalLimit,
                                  long readGlobalLimit,
                                  long writeChannelLimit,
                                  long readChannelLimit,
                                  long checkInterval)

Create a new instance.

Parameters:

timer - the Timer to use for the TrafficCounter.

writeGlobalLimit - 0 or a limit in bytes/s

readGlobalLimit - 0 or a limit in bytes/s

writeChannelLimit - 0 or a limit in bytes/s

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

GlobalChannelTrafficShapingHandler

public GlobalChannelTrafficShapingHandler(Timer timer,
                                  long writeGlobalLimit,
                                  long readGlobalLimit,
                                  long writeChannelLimit,
                                  long readChannelLimit)

Create a new instance.

Parameters:

timer - the Timer to use for the TrafficCounter.

writeGlobalLimit - 0 or a limit in bytes/s

readGlobalLimit - 0 or a limit in bytes/s

writeChannelLimit - 0 or a limit in bytes/s

readChannelLimit - 0 or a limit in bytes/s

GlobalChannelTrafficShapingHandler

public GlobalChannelTrafficShapingHandler(Timer timer,
                                  long checkInterval)

Create a new instance.

Parameters:

timer - the Timer to use for the TrafficCounter.

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

GlobalChannelTrafficShapingHandler

public GlobalChannelTrafficShapingHandler(Timer timer)

Create a new instance.

Parameters:

timer - the Timer to use for the TrafficCounter.

GlobalChannelTrafficShapingHandler

public GlobalChannelTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator,
                                  Timer timer,
                                  long writeLimit,
                                  long readLimit,
                                  long writeChannelLimit,
                                  long readChannelLimit,
                                  long checkInterval,
                                  long maxTime)

Parameters:

objectSizeEstimator - ObjectSizeEstimator to use

timer - the Timer to use for the TrafficCounter.

writeLimit - write Global Limit 0 or a limit in bytes/s

readLimit - read Global Limit 0 or a limit in bytes/s

writeChannelLimit - 0 or a limit in bytes/s

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

GlobalChannelTrafficShapingHandler

public GlobalChannelTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator,
                                  Timer timer,
                                  long writeLimit,
                                  long readLimit,
                                  long writeChannelLimit,
                                  long readChannelLimit,
                                  long checkInterval)

Parameters:

objectSizeEstimator - ObjectSizeEstimator to use

timer - the Timer to use for the TrafficCounter.

writeLimit - write Global Limit 0 or a limit in bytes/s

readLimit - read Global Limit 0 or a limit in bytes/s

writeChannelLimit - 0 or a limit in bytes/s

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

GlobalChannelTrafficShapingHandler

public GlobalChannelTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator,
                                  Timer timer,
                                  long writeLimit,
                                  long readLimit,
                                  long writeChannelLimit,
                                  long readChannelLimit)

Parameters:

objectSizeEstimator - ObjectSizeEstimator to use

timer - the Timer to use for the TrafficCounter.

writeLimit - write Global Limit 0 or a limit in bytes/s

readLimit - read Global Limit 0 or a limit in bytes/s

writeChannelLimit - 0 or a limit in bytes/s

readChannelLimit - 0 or a limit in bytes/s

GlobalChannelTrafficShapingHandler

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

Parameters:

objectSizeEstimator - ObjectSizeEstimator to use

timer - the Timer to use for the TrafficCounter.

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

GlobalChannelTrafficShapingHandler

public GlobalChannelTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator,
                                  Timer timer)

Parameters:

objectSizeEstimator - ObjectSizeEstimator to use

timer - the Timer to use for the TrafficCounter.

Method Detail

maxDeviation

public float maxDeviation()

Returns:

the current max deviation.

accelerationFactor

public float accelerationFactor()

Returns:

the current acceleration factor.

slowDownFactor

public float slowDownFactor()

Returns:

the current slow down factor.

setMaxDeviation

public void setMaxDeviation(float maxDeviation,
                   float slowDownFactor,
                   float accelerationFactor)

Parameters:

maxDeviation - the maximum deviation to allow during computation of average, default deviation being 0.1, so +/-10% of the desired bandwidth. Maximum being 0.4.

slowDownFactor - the factor set as +x% to the too fast client (minimal value being 0, meaning no slow down factor), default being 40% (0.4).

accelerationFactor - the factor set as -x% to the too slow client (maximal value being 0, meaning no acceleration factor), default being -10% (-0.1).

doAccounting

protected void doAccounting(TrafficCounter counter)

Description copied from class: AbstractTrafficShapingHandler

Called each time the accounting is computed from the TrafficCounters. This method could be used for instance to implement almost real time accounting.

Overrides:

doAccounting in class AbstractTrafficShapingHandler

Parameters:

counter - the TrafficCounter that computes its performance

getMaxGlobalWriteSize

public long getMaxGlobalWriteSize()

Returns:

the maxGlobalWriteSize

setMaxGlobalWriteSize

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

Parameters:

maxGlobalWriteSize - the maximum Global Write Size allowed in the buffer globally for all channels before write suspended is set.

queuesSize

public long queuesSize()

Returns:

the global size of the buffers for all queues.

configureChannel

public void configureChannel(long newWriteLimit,
                    long newReadLimit)

Parameters:

newWriteLimit - Channel write limit

newReadLimit - Channel read limit

getWriteChannelLimit

public long getWriteChannelLimit()

Returns:

Channel write limit.

setWriteChannelLimit

public void setWriteChannelLimit(long writeLimit)

Parameters:

writeLimit - Channel write limit

getReadChannelLimit

public long getReadChannelLimit()

Returns:

Channel read limit.

setReadChannelLimit

public void setReadChannelLimit(long readLimit)

Parameters:

readLimit - Channel read limit

release

public final void release()

Release all internal resources of this instance.

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

messageReceived

public void messageReceived(ChannelHandlerContext ctx,
                   MessageEvent evt)
                     throws Exception

Description copied from class: SimpleChannelHandler

Invoked when a message object (e.g: ChannelBuffer) was received from a remote peer.

Overrides:

messageReceived in class AbstractTrafficShapingHandler

Throws:

Exception

checkWaitReadTime

protected long checkWaitReadTime(ChannelHandlerContext ctx,
                     long wait,
                     long now)

Description copied from class: AbstractTrafficShapingHandler

Method overridden in GTSH to take into account specific timer for the channel.

wait - the wait delay computed in ms

now - the relative now time in ms

Returns:

the wait to use according to the context.

informReadOperation

protected void informReadOperation(ChannelHandlerContext ctx,
                       long now)

Description copied from class: AbstractTrafficShapingHandler

Method overridden in GTSH to take into account specific timer for the channel.

now - the relative now time in ms

maximumCumulativeWrittenBytes

protected long maximumCumulativeWrittenBytes()

maximumCumulativeReadBytes

protected long maximumCumulativeReadBytes()

channelTrafficCounters

public Collection<TrafficCounter> channelTrafficCounters()

To allow for instance doAccounting to use the TrafficCounter per channel.

Returns:

the list of TrafficCounters that exists at the time of the call.

writeRequested

public void writeRequested(ChannelHandlerContext ctx,
                  MessageEvent evt)
                    throws Exception

Description copied from class: SimpleChannelHandler

Invoked when Channel.write(Object) is called.

Overrides:

writeRequested in class AbstractTrafficShapingHandler

Throws:

Exception

submitWrite

protected void submitWrite(ChannelHandlerContext ctx,
               MessageEvent evt,
               long size,
               long writedelay,
               long now)
                    throws Exception

Throws:

Exception

toString

public String toString()

Overrides:

toString in class AbstractTrafficShapingHandler