Add doc about NettyToVertxHandler

hawkular · Jun 26, 2015 · 14bf6a4 · 14bf6a4
1 parent 222fbf2
commit 14bf6a4
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/clients/ptranslator/src/main/java/org/hawkular/metrics/clients/ptrans/PTrans.java b/clients/ptranslator/src/main/java/org/hawkular/metrics/clients/ptrans/PTrans.java
@@ -66,6 +66,8 @@ public class PTrans {
     private final Vertx vertx;
     private final EventLoopGroup group;
     private final EventLoopGroup workerGroup;
+    // Needed as long as some servers are still Netty-based
+    // Can be removed as soon as all servers are implemented on top of vertx
     private final NettyToVertxHandler nettyToVertxHandler;
 
     private String metricsSenderID;

diff --git a/...slator/src/main/java/org/hawkular/metrics/clients/ptrans/backend/NettyToVertxHandler.java b/...slator/src/main/java/org/hawkular/metrics/clients/ptrans/backend/NettyToVertxHandler.java
@@ -28,6 +28,9 @@
 import io.vertx.core.eventbus.EventBus;
 
 /**
+ * A channel used during transition from vanilla Netty to vertx 3. At the time of writing only collectd and graphite
+ * servers have been refactored. This class can be deleted as soon as all servers are implemented on top of vertx.
+ *
  * @author Thomas Segismont
  */
 @Sharable