Examples of io.netty.handler.traffic.ChannelTrafficShapingHandler

• io.netty.handler.traffic.ChannelTrafficShapingHandler
  This implementation of the {@link AbstractTrafficShapingHandler} is for channeltraffic shaping, that is to say a per channel limitation of the bandwidth.
  
  The general use should be as follow:
  

  • Add in your pipeline a new ChannelTrafficShapingHandler, before a recommended {@link ExecutionHandler} (like{@link OrderedMemoryAwareThreadPoolExecutor} or {@link MemoryAwareThreadPoolExecutor}).
    ChannelTrafficShapingHandler myHandler = new ChannelTrafficShapingHandler(executor);
    executor could be created using Executors.newCachedThreadPool();
    pipeline.addLast("CHANNEL_TRAFFIC_SHAPING", myHandler);
    
    Note that this handler has a Pipeline Coverage of "one" which means a new handler must be created for each new channel as the counter cannot be shared among all channels. For instance, if you have a {@link ChannelPipelineFactory}, you should create a new ChannelTrafficShapingHandler in this {@link ChannelPipelineFactory} each time getPipeline() method is called.
    
    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.
    
  • When you shutdown your application, release all the external resources like the executor by calling:
    myHandler.releaseExternalResources();
    

  
  

Related Classes of io.netty.handler.traffic.ChannelTrafficShapingHandler