Change Executor to Timer from Netty, in reference to Issue #345

src/main/java/org/jboss/netty/handler/traffic/package-info.java

@@ -17,26 +17,28 @@
 /**
  * Implementation of a Traffic Shaping Handler and Dynamic Statistics.<br>
  * <br><br>
+ *
+ *
  * <P>The main goal of this package is to allow to shape the traffic (bandwidth limitation),
  * but also to get statistics on how many bytes are read or written. Both functions can
  * be active or inactive (traffic or statistics).</P>
  *
  * <P>Two classes implement this behavior:<br>
  * <ul>
- * <li> <tt>{@link org.jboss.netty.handler.traffic.TrafficCounter}</tt>: this class implements the counters needed by the handlers.
+ * <li> <tt>{@link TrafficCounter}</tt>: this class implements the counters needed by the handlers.
  * It can be accessed to get some extra information like the read or write bytes since last check, the read and write
  * bandwidth from last check...</li><br><br>
  *
- * <li> <tt>{@link org.jboss.netty.handler.traffic.AbstractTrafficShapingHandler}</tt>: this abstract class implements the kernel
+ * <li> <tt>{@link AbstractTrafficShapingHandler}</tt>: this abstract class implements the kernel
  * of the traffic shaping. It could be extended to fit your needs. Two classes are proposed as default
- * implementations: see {@link org.jboss.netty.handler.traffic.ChannelTrafficShapingHandler} and see {@link org.jboss.netty.handler.traffic.GlobalTrafficShapingHandler}
+ * implementations: see {@link ChannelTrafficShapingHandler} and see {@link GlobalTrafficShapingHandler}
  * respectively for Channel traffic shaping and Global traffic shaping.</li><br><br>
  *
  * The insertion in the pipeline of one of those handlers can be wherever you want, but
- * <b>it must be placed before any <tt>{@link org.jboss.netty.handler.execution.MemoryAwareThreadPoolExecutor}</tt>
+ * <b>it must be placed before any <tt>{@link MemoryAwareThreadPoolExecutor}</tt>
- * in your pipeline</b>.<br>
+ * in your pipeline</b>.</li><br>
- * <b><i>It is really recommended to have such a</i> <tt>{@link org.jboss.netty.handler.execution.MemoryAwareThreadPoolExecutor}</tt>
+ * <b><i>It is really recommended to have such a</i> <tt>{@link MemoryAwareThreadPoolExecutor}</tt>
- * <i>(either non ordered or </i> <tt>{@link org.jboss.netty.handler.execution.OrderedMemoryAwareThreadPoolExecutor}</tt>
+ * <i>(either non ordered or </i> <tt>{@link OrderedMemoryAwareThreadPoolExecutor}</tt>
  * <i>) in your pipeline</i></b>
  * when you want to use this feature with some real traffic shaping, since it will allow to relax the constraint on
  * NioWorker to do other jobs if necessary.<br>
@@ -48,9 +50,9 @@
  * 60KB/s for each channel since NioWorkers are stopping by this handler.<br>
  * When it is used as a read traffic shaper, the handler will set the channel as not readable, so as to relax the
  * NioWorkers.<br><br>
- * An {@link org.jboss.netty.util.ObjectSizeEstimator} can be passed at construction to specify what
+ * An {@link 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 {@link org.jboss.netty.util.DefaultObjectSizeEstimator} implementation.<br><br>
+ * object. If not specified, it will used the {@link DefaultObjectSizeEstimator} implementation.<br><br>
  * </ul></P>
  *
  * <P>Standard use could be as follow:</P>
@@ -60,27 +62,27 @@
  * [Global or per Channel] [Write or Read] Limitation in byte/s.</li><br>
  * A value of <tt>0</tt>
  * stands for no limitation, so the traffic shaping is deactivate (on what you specified).<br>
- * You can either change those values with the method <tt>configure</tt> in {@link org.jboss.netty.handler.traffic.AbstractTrafficShapingHandler}.<br>
+ * You can either change those values with the method <tt>configure</tt> in {@link AbstractTrafficShapingHandler}.<br>
  * <br>
  *
  * <li>To activate or deactivate the statistics, you can adjust the delay to a low (suggested not less than 200ms
  * for efficiency reasons) or a high value (let say 24H in millisecond is huge enough to not get the problem)
  * or even using <tt>0</tt> which means no computation will be done.</li><br>
  * If you want to do anything with this statistics, just override the <tt>doAccounting</tt> method.<br>
- * This interval can be changed either from the method <tt>configure</tt> in {@link org.jboss.netty.handler.traffic.AbstractTrafficShapingHandler}
+ * This interval can be changed either from the method <tt>configure</tt> in {@link AbstractTrafficShapingHandler}
- * or directly using the method <tt>configure</tt> of {@link org.jboss.netty.handler.traffic.TrafficCounter}.<br><br>
+ * or directly using the method <tt>configure</tt> of {@link TrafficCounter}.<br><br>
  *
  * </ul></P><br><br>
  *
  * <P>So in your application you will create your own TrafficShapingHandler and set the values to fit your needs.</P>
- * <tt>XXXXXTrafficShapingHandler myHandler = new XXXXXTrafficShapingHandler(executor);</tt><br><br>
+ * <tt>XXXXXTrafficShapingHandler myHandler = new XXXXXTrafficShapingHandler(timer);</tt><br><br>
- * where executor could be created using <tt>Executors.newCachedThreadPool();</tt> and XXXXX could be either
+ * timer could be created using <tt>HashedWheelTimer<tt> and XXXXX could be either
  * Global or Channel<br>
  * <tt>pipeline.addLast("XXXXX_TRAFFIC_SHAPING", myHandler);</tt><br>
  * <tt>...</tt><br>
  * <tt>pipeline.addLast("MemoryExecutor",new ExecutionHandler(memoryAwareThreadPoolExecutor));</tt><br><br>
- * <P>Note that a new {@link org.jboss.netty.handler.traffic.ChannelTrafficShapingHandler} must be created for each new channel,
+ * <P>Note that a new {@link ChannelTrafficShapingHandler} must be created for each new channel,
- * but only one {@link org.jboss.netty.handler.traffic.GlobalTrafficShapingHandler} must be created for all channels.</P>
+ * but only one {@link GlobalTrafficShapingHandler} must be created for all channels.</P>
  *
  * <P>Note also that you can create different GlobalTrafficShapingHandler if you want to separate classes of
  * channels (for instance either from business point of view or from bind address point of view).</P>