@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.
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();AbstractTrafficShapingHandler.SimpleObjectSizeEstimatorChannelHandler.SharablecheckInterval, DEFAULT_CHECK_INTERVAL, DEFAULT_MAX_TIME, maxTime, timer, trafficCounter| 构造器和说明 |
|---|
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) |
| 限定符和类型 | 方法和说明 |
|---|---|
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) |
calculateSize, configure, configure, configure, doAccounting, getCheckInterval, getMaxTimeWait, getMaxWriteDelay, getMaxWriteSize, getReadLimit, getTrafficCounter, getWriteLimit, internalSubmitWrite, messageReceived, setCheckInterval, setMaxTimeWait, setMaxWriteDelay, setMaxWriteSize, setReadLimit, setWriteLimit, submitWrite, toString, writeRequestedbindRequested, channelBound, channelDisconnected, channelInterestChanged, channelOpen, channelUnbound, childChannelClosed, childChannelOpen, closeRequested, connectRequested, disconnectRequested, exceptionCaught, handleDownstream, handleUpstream, setInterestOpsRequested, unbindRequested, writeCompletepublic GlobalTrafficShapingHandler(Timer timer, long writeLimit, long readLimit, long checkInterval)
public GlobalTrafficShapingHandler(Timer timer, long writeLimit, long readLimit, long checkInterval, long maxTime)
public GlobalTrafficShapingHandler(Timer timer, long writeLimit, long readLimit)
public GlobalTrafficShapingHandler(Timer timer, long checkInterval)
public GlobalTrafficShapingHandler(Timer timer)
public GlobalTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer, long writeLimit, long readLimit, long checkInterval)
public GlobalTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer, long writeLimit, long readLimit, long checkInterval, long maxTime)
public GlobalTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer, long writeLimit, long readLimit)
public GlobalTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer, long checkInterval)
public GlobalTrafficShapingHandler(ObjectSizeEstimator objectSizeEstimator, Timer timer)
public long getMaxGlobalWriteSize()
public void setMaxGlobalWriteSize(long maxGlobalWriteSize)
maxGlobalWriteSize - the maximum Global Write Size allowed in the buffer
globally for all channels before write suspended is set,
default value being 400 MB.public long queuesSize()
public void channelConnected(ChannelHandlerContext ctx, ChannelStateEvent e) throws java.lang.Exception
SimpleChannelHandlerChannel is open, bound to a local address, and
connected to a remote address.channelConnected 在类中 AbstractTrafficShapingHandlerjava.lang.Exceptionpublic void channelClosed(ChannelHandlerContext ctx, ChannelStateEvent e) throws java.lang.Exception
SimpleChannelHandlerChannel was closed and all its related resources
were released.channelClosed 在类中 SimpleChannelHandlerjava.lang.Exceptionpublic void releaseExternalResources()
ExternalResourceReleasable