org.jboss.netty.handler.traffic

Class AbstractTrafficShapingHandler

java.lang.Object

org.jboss.netty.channel.SimpleChannelHandler

org.jboss.netty.handler.traffic.AbstractTrafficShapingHandler

All Implemented Interfaces:

ChannelDownstreamHandler, ChannelHandler, ChannelUpstreamHandler, ExternalResourceReleasable

Direct Known Subclasses:

ChannelTrafficShapingHandler, GlobalTrafficShapingHandler

public abstract class AbstractTrafficShapingHandler
extends SimpleChannelHandler
implements ExternalResourceReleasable

AbstractTrafficShapingHandler allows to limit the global bandwidth (see GlobalTrafficShapingHandler) or per session bandwidth (see ChannelTrafficShapingHandler), as traffic shaping. It allows too to implement an almost real time monitoring of the bandwidth using the monitors from TrafficCounter that will call back every checkInterval the method doAccounting of this handler.

An ObjectSizeEstimator can be passed at construction to specify what is the size of the object to be read or write accordingly to the type of object. If not specified, it will used the DefaultObjectSizeEstimator implementation.

If you want for any particular reasons to stop the monitoring (accounting) or to change the read/write limit or the check interval, several methods allow that for you:

• configure allows you to change read or write limits, or the checkInterval
• getTrafficCounter allows you to have access to the TrafficCounter and so to stop or start the monitoring, to change the checkInterval directly, or to have access to its values.

Nested Class Summary

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

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
protected long	checkInterval Delay between two performance snapshots
static long	DEFAULT_CHECK_INTERVAL Default delay between two checks: 1s
static long	DEFAULT_MAX_TIME Default max delay in case of traffic shaping (during which no communication will occur).
protected long	maxTime Max delay in wait
protected Timer	timer Timer associated to any TrafficCounter
protected TrafficCounter	trafficCounter Traffic Counter

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer) Constructor using the specified ObjectSizeEstimator and using NO LIMIT and default Check Interval
protected	AbstractTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer, long checkInterval) Constructor using the specified ObjectSizeEstimator and using NO LIMIT
protected	AbstractTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer, long writeLimit, long readLimit) Constructor using the specified ObjectSizeEstimator and using default Check Interval
protected	AbstractTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer, long writeLimit, long readLimit, long checkInterval) Constructor using the specified ObjectSizeEstimator
protected	AbstractTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer, long writeLimit, long readLimit, long checkInterval, long maxTime) Constructor using the specified ObjectSizeEstimator
protected	AbstractTrafficShapingHandler(Timer timer) Constructor using default ObjectSizeEstimator and using NO LIMIT and default Check Interval
protected	AbstractTrafficShapingHandler(Timer timer, long checkInterval) Constructor using default ObjectSizeEstimator and using NO LIMIT
protected	AbstractTrafficShapingHandler(Timer timer, long writeLimit, long readLimit) Constructor using default ObjectSizeEstimator and using default Check Interval
protected	AbstractTrafficShapingHandler(Timer timer, long writeLimit, long readLimit, long checkInterval) Constructor using default ObjectSizeEstimator
protected	AbstractTrafficShapingHandler(Timer timer, long writeLimit, long readLimit, long checkInterval, long maxTime) Constructor using default ObjectSizeEstimator

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(long newCheckInterval) Change the check interval.
void	configure(long newWriteLimit, long newReadLimit) Change the underlying limitations.
void	configure(long newWriteLimit, long newReadLimit, long newCheckInterval) Change the underlying limitations and check interval.
protected void	doAccounting(TrafficCounter counter) Called each time the accounting is computed from the TrafficCounters.
long	getCheckInterval()
long	getMaxTimeWait()
long	getReadLimit()
TrafficCounter	getTrafficCounter()
long	getWriteLimit()
void	handleDownstream(ChannelHandlerContext ctx, ChannelEvent e) Handles the specified downstream event.
protected void	internalSubmitWrite(ChannelHandlerContext ctx, MessageEvent evt)
void	messageReceived(ChannelHandlerContext ctx, MessageEvent evt) Invoked when a message object (e.g: ChannelBuffer) was received from a remote peer.
void	releaseExternalResources() Releases the external resources that this object depends on.
void	setCheckInterval(long newCheckInterval)
void	setMaxTimeWait(long maxTime)
void	setReadLimit(long readLimit)
void	setWriteLimit(long writeLimit)
protected abstract void	submitWrite(ChannelHandlerContext ctx, MessageEvent evt, long delay)
String	toString()
void	writeRequested(ChannelHandlerContext ctx, MessageEvent evt) Invoked when Channel.write(Object) is called.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHECK_INTERVAL

public static final long DEFAULT_CHECK_INTERVAL

Default delay between two checks: 1s

See Also:

Constant Field Values

DEFAULT_MAX_TIME

public static final long DEFAULT_MAX_TIME

Default max delay in case of traffic shaping (during which no communication will occur). Shall be less than TIMEOUT. Here half of "standard" 30s

See Also:

Constant Field Values

trafficCounter

protected TrafficCounter trafficCounter

Traffic Counter

timer

protected Timer timer

Timer associated to any TrafficCounter

checkInterval

protected long checkInterval

Delay between two performance snapshots

maxTime

protected long maxTime

Max delay in wait

Constructor Detail

AbstractTrafficShapingHandler

protected AbstractTrafficShapingHandler(Timer timer,
                             long writeLimit,
                             long readLimit,
                             long checkInterval)

Constructor using default ObjectSizeEstimator

Parameters:

timer - created once for instance like HashedWheelTimer(10, TimeUnit.MILLISECONDS, 1024)

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

AbstractTrafficShapingHandler

protected AbstractTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator,
                             Timer timer,
                             long writeLimit,
                             long readLimit,
                             long checkInterval)

Constructor using the specified ObjectSizeEstimator

Parameters:

objectSizeEstimator - the ObjectSizeEstimator that will be used to compute the size of the message

timer - created once for instance like HashedWheelTimer(10, TimeUnit.MILLISECONDS, 1024)

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

AbstractTrafficShapingHandler

protected AbstractTrafficShapingHandler(Timer timer,
                             long writeLimit,
                             long readLimit)

Constructor using default ObjectSizeEstimator and using default Check Interval

Parameters:

timer - created once for instance like HashedWheelTimer(10, TimeUnit.MILLISECONDS, 1024)

writeLimit - 0 or a limit in bytes/s

readLimit - 0 or a limit in bytes/s

AbstractTrafficShapingHandler

protected AbstractTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator,
                             Timer timer,
                             long writeLimit,
                             long readLimit)

Constructor using the specified ObjectSizeEstimator and using default Check Interval

Parameters:

objectSizeEstimator - the ObjectSizeEstimator that will be used to compute the size of the message

timer - created once for instance like HashedWheelTimer(10, TimeUnit.MILLISECONDS, 1024)

writeLimit - 0 or a limit in bytes/s

readLimit - 0 or a limit in bytes/s

AbstractTrafficShapingHandler

protected AbstractTrafficShapingHandler(Timer timer)

Constructor using default ObjectSizeEstimator and using NO LIMIT and default Check Interval

Parameters:

timer - created once for instance like HashedWheelTimer(10, TimeUnit.MILLISECONDS, 1024)

AbstractTrafficShapingHandler

protected AbstractTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator,
                             Timer timer)

Constructor using the specified ObjectSizeEstimator and using NO LIMIT and default Check Interval

Parameters:

objectSizeEstimator - the ObjectSizeEstimator that will be used to compute the size of the message

timer - created once for instance like HashedWheelTimer(10, TimeUnit.MILLISECONDS, 1024)

AbstractTrafficShapingHandler

protected AbstractTrafficShapingHandler(Timer timer,
                             long checkInterval)

Constructor using default ObjectSizeEstimator and using NO LIMIT

Parameters:

timer - created once for instance like HashedWheelTimer(10, TimeUnit.MILLISECONDS, 1024)

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

AbstractTrafficShapingHandler

protected AbstractTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator,
                             Timer timer,
                             long checkInterval)

Constructor using the specified ObjectSizeEstimator and using NO LIMIT

Parameters:

objectSizeEstimator - the ObjectSizeEstimator that will be used to compute the size of the message

timer - created once for instance like HashedWheelTimer(10, TimeUnit.MILLISECONDS, 1024)

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

AbstractTrafficShapingHandler

protected AbstractTrafficShapingHandler(Timer timer,
                             long writeLimit,
                             long readLimit,
                             long checkInterval,
                             long maxTime)

Constructor using default ObjectSizeEstimator

Parameters:

timer - created once for instance like HashedWheelTimer(10, TimeUnit.MILLISECONDS, 1024)

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 max time to wait in case of excess of traffic (to prevent Time Out event)

AbstractTrafficShapingHandler

protected AbstractTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator,
                             Timer timer,
                             long writeLimit,
                             long readLimit,
                             long checkInterval,
                             long maxTime)

Constructor using the specified ObjectSizeEstimator

Parameters:

objectSizeEstimator - the ObjectSizeEstimator that will be used to compute the size of the message

timer - created once for instance like HashedWheelTimer(10, TimeUnit.MILLISECONDS, 1024)

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 max time to wait in case of excess of traffic (to prevent Time Out event)

Method Detail

configure

public void configure(long newWriteLimit,
             long newReadLimit,
             long newCheckInterval)

Change the underlying limitations and check interval.

configure

public void configure(long newWriteLimit,
             long newReadLimit)

Change the underlying limitations.

configure

public void configure(long newCheckInterval)

Change the check interval.

getWriteLimit

public long getWriteLimit()

Returns:

the writeLimit

setWriteLimit

public void setWriteLimit(long writeLimit)

Parameters:

writeLimit - the writeLimit to set

getReadLimit

public long getReadLimit()

Returns:

the readLimit

setReadLimit

public void setReadLimit(long readLimit)

Parameters:

readLimit - the readLimit to set

getCheckInterval

public long getCheckInterval()

Returns:

the checkInterval

setCheckInterval

public void setCheckInterval(long newCheckInterval)

Parameters:

newCheckInterval - the checkInterval to set

getMaxTimeWait

public long getMaxTimeWait()

Returns:

the max delay on wait

setMaxTimeWait

public void setMaxTimeWait(long maxTime)

Parameters:

maxTime - Max delay in wait, shall be less than TIME OUT in related protocol

doAccounting

protected void doAccounting(TrafficCounter counter)

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

Parameters:

counter - the TrafficCounter that computes its performance

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 SimpleChannelHandler

Throws:

Exception

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 SimpleChannelHandler

Throws:

Exception

internalSubmitWrite

protected void internalSubmitWrite(ChannelHandlerContext ctx,
                       MessageEvent evt)
                            throws Exception

Throws:

Exception

submitWrite

protected abstract void submitWrite(ChannelHandlerContext ctx,
               MessageEvent evt,
               long delay)
                             throws Exception

Throws:

Exception

handleDownstream

public void handleDownstream(ChannelHandlerContext ctx,
                    ChannelEvent e)
                      throws Exception

Description copied from class: SimpleChannelHandler

Handles the specified downstream event. Down-casts the received downstream event into more meaningful sub-type event and calls an appropriate handler method with the down-casted event.

Specified by:

handleDownstream in interface ChannelDownstreamHandler

Overrides:

handleDownstream in class SimpleChannelHandler

Parameters:

ctx - the context object for this handler

e - the downstream event to process or intercept

Throws:

Exception

getTrafficCounter

public TrafficCounter getTrafficCounter()

Returns:

the current TrafficCounter (if channel is still connected)

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

toString

public String toString()

Overrides:

toString in class Object