io.netty.handler.traffic

Class AbstractTrafficShapingHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.handler.traffic.AbstractTrafficShapingHandler

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

Direct Known Subclasses:

ChannelTrafficShapingHandler, GlobalTrafficShapingHandler

public abstract class AbstractTrafficShapingHandler
extends ChannelDuplexHandler

AbstractTrafficShapingHandler allows to limit the global bandwidth (see GlobalTrafficShapingHandler) or per session bandwidth (see ChannelTrafficShapingHandler), as traffic shaping. It allows you 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.

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 io.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
protected TrafficCounter	trafficCounter Traffic Counter

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTrafficShapingHandler() Constructor using NO LIMIT and default Check Interval
protected	AbstractTrafficShapingHandler(long checkInterval) Constructor using NO LIMIT
protected	AbstractTrafficShapingHandler(long writeLimit, long readLimit) Constructor using default Check Interval
protected	AbstractTrafficShapingHandler(long writeLimit, long readLimit, long checkInterval)

Method Summary

Methods

Modifier and Type	Method and Description
void	channelRead(ChannelHandlerContext ctx, Object msg) Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
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.
void	handlerRemoved(ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.
void	read(ChannelHandlerContext ctx) Calls ChannelOutboundInvoker.read() to forward to the next ChannelOutboundHandler in the ChannelPipeline.
String	toString()
TrafficCounter	trafficCounter()
void	write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) Calls ChannelOutboundInvoker.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.

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, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

exceptionCaught, handlerAdded

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, handlerAdded

Field Detail

DEFAULT_CHECK_INTERVAL

public static final long DEFAULT_CHECK_INTERVAL

Default delay between two checks: 1s

See Also:

Constant Field Values

trafficCounter

protected TrafficCounter trafficCounter

Traffic Counter

checkInterval

protected long checkInterval

Delay between two performance snapshots

Constructor Detail

AbstractTrafficShapingHandler

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

Parameters:

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(long writeLimit,
                             long readLimit)

Constructor using default Check Interval

Parameters:

writeLimit - 0 or a limit in bytes/s

readLimit - 0 or a limit in bytes/s

AbstractTrafficShapingHandler

protected AbstractTrafficShapingHandler()

Constructor using NO LIMIT and default Check Interval

AbstractTrafficShapingHandler

protected AbstractTrafficShapingHandler(long checkInterval)

Constructor using NO LIMIT

Parameters:

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

Method Detail

configure

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

Change the underlying limitations and check interval.

Parameters:

newWriteLimit - The new write limit (in bytes)

newReadLimit - The new read limit (in bytes)

newCheckInterval - The new check interval (in milliseconds)

configure

public void configure(long newWriteLimit,
             long newReadLimit)

Change the underlying limitations.

Parameters:

newWriteLimit - The new write limit (in bytes)

newReadLimit - The new read limit (in bytes)

configure

public void configure(long newCheckInterval)

Change the check interval.

Parameters:

newCheckInterval - The new check interval (in milliseconds)

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

channelRead

public void channelRead(ChannelHandlerContext ctx,
               Object msg)
                 throws Exception

Description copied from class: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

channelRead in interface ChannelInboundHandler

Overrides:

channelRead in class ChannelInboundHandlerAdapter

Throws:

Exception

read

public void read(ChannelHandlerContext ctx)

Description copied from class: ChannelDuplexHandler

Calls ChannelOutboundInvoker.read() to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

read in interface ChannelOutboundHandler

Overrides:

read in class ChannelDuplexHandler

write

public void write(ChannelHandlerContext ctx,
         Object msg,
         ChannelPromise promise)
           throws Exception

Description copied from class: ChannelDuplexHandler

Calls ChannelOutboundInvoker.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

write in interface ChannelOutboundHandler

Overrides:

write in class ChannelDuplexHandler

Parameters:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error accour

trafficCounter

public TrafficCounter trafficCounter()

Returns:

the current TrafficCounter (if channel is still connected)

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

toString

public String toString()

Overrides:

toString in class Object