version 0.0.1.0 update Normal alpha 13

Author: H00001

src/top/gunplan/netty/GunBootServer.java

@@ -8,7 +8,7 @@
 
 /**
  * server interface ,has kinds of implements but now we have only one
- * {@link top.gunplan.netty.impl.GunBootServerImpl}
+ * it is NioStdServerImpl
  *
  * @author dosdrtt
  * @since 0.0.0.1
@@ -41,28 +41,30 @@ public interface GunBootServer {
     GunBootServer setExecuters(@NotNull ExecutorService acceptExecuters, @NotNull ExecutorService requestExecuters);
 
     /**
-     * set a deal handel implement {@link GunNettyHandle }
-     *
-     * @param handel Execute Class
-     * @return GunBootServer:this chain style
+     * this method return a {@link GunPilelineInterface} implements
+     * @return GunPilelineInterface
      */
     GunPilelineInterface getPipeline();
 
-    /**
-     * the function is used to add filter
-     *
-     * @param filter filter, filter the request
-     * @return GunBootServer chain style
-     */
-
+//    /**
+//     * the function is used to add filter
+//     *
+//     * @param filter filter, filter the request
+//     * @return GunBootServer chain style
+//     */
+//
+//
+//    /**
+//     * @param clazz class to deal
+//     * @throws ClassNotFoundException class not found
+//     * @apiNote
+//     */
+//    void inintObject(@NotNull Class<? extends GunHandle> clazz) throws Exception;
 
     /**
-     * @param clazz class to deal
-     * @throws ClassNotFoundException class not found
-     * @apiNote
+     * check it can or not be boot
+     * @return check result true is can be boot
      */
-//    void inintObject(@NotNull Class<? extends GunHandle> clazz) throws Exception;
-
     boolean initCheck();
 
 }

src/top/gunplan/netty/GunCoreEventLoopInterface.java

@@ -3,13 +3,16 @@
 import java.nio.channels.SelectionKey;
 
 /**
- *GunCoreEventLoopInterface event loop deal class
+ * GunCoreEventLoopInterface event loop deal class
+ * when event happened, function `dealEvent` will be
+ * execute
+ * @author dosdrtt
  */
 public interface GunCoreEventLoopInterface {
     /**
      * when the event come ,the method will be call back
      * @param key SelectionKey input the SelectionKey
-     * @throws Exception SelectionKey
+     * @throws Exception Kinds of Exception
      */
     void dealEvent(SelectionKey key) throws Exception;
 }

src/top/gunplan/netty/GunException.java

@@ -1,7 +1,7 @@
 package top.gunplan.netty;
 
 /**
- * std exception
+ * std exception in gun netty
  * @author dosdrtt
  */
 public class GunException extends RuntimeException {

src/top/gunplan/netty/GunHandle.java

@@ -1,7 +1,8 @@
 package top.gunplan.netty;
 
 /**
- * this is a handle interface
+ * this is a handle interface ,include {@link GunNettyFilter }
+ * and {@link GunNettyHandle}
  * @author dosdrtt
  * @since 0.0.0.3
  */

src/top/gunplan/netty/GunNettyFilter.java

@@ -1,7 +1,7 @@
 package top.gunplan.netty;
 
 
-import top.gunplan.netty.impl.GunRequestFilterDto;
+import top.gunplan.netty.impl.GunInputFilterChecker;
 import top.gunplan.netty.impl.example.GunOutputFilterDto;
 
 /**
@@ -10,21 +10,26 @@
  * @author dosdrtt
  */
 public interface GunNettyFilter extends GunHandle {
-    /**
-     * doing filter when the request occur
-     *
-     * @param filterDto input to the filter's deal Object
-     * @return filter result true:next false:break
-     */
 
-    public enum DealResult {
+
+    enum DealResult {
         /**
-         *
+         * NOTDEALINPUT  :do not deal input filter ,go for handle right away
+         * CLOSE         :do not deal any filter or handle
+         * NEXT          :nothing will happened
+         * NOTDEALOUTPUT :exit output filter chain and handle but it wasn't close
+         * NOTDEALALLNEXT:ecit all filter chain and handle but it wasn't close
          */
         NOTDEALINPUT, CLOSE, NEXT, NOTDEALOUTPUT, NOTDEALALLNEXT;
     }
 
-    DealResult doInputFilter(GunRequestFilterDto filterDto) throws Exception;
+    /**
+     *
+     * @param filterDto input filter dto
+     * @return deal result {@link DealResult};
+     * @throws Exception kinds of exception
+     */
+    DealResult doInputFilter(GunInputFilterChecker filterDto) throws Exception;
 
     /**
      * doing filter when the response occur

src/top/gunplan/netty/GunPilelineCheckResult.java

@@ -1,12 +1,16 @@
 package top.gunplan.netty;
 
 /**
- *
+ * @author dosdrtt
+ * Thread safe
  */
 public class GunPilelineCheckResult {
     public  enum CheckResult {
         /**
-         *
+         * ERROR    : do not have any filters or handls
+         * SAFE     : have been sat
+         * WARNNING :
+         * UNSAFE   :
          */
         ERROR, SAFE, WARNNING, UNSAFE
     }

src/top/gunplan/netty/common/GunNettyPropertyManager.java

@@ -12,6 +12,7 @@
 
 
 /**
+ * analyzing config information by reference
  * @author dosdrtt
  */
 public final class GunNettyPropertyManager {

src/top/gunplan/netty/filters/GunHttpdHostCheck.java

@@ -3,14 +3,14 @@
 import top.gunplan.netty.GunNettyFilter;
 import top.gunplan.netty.anno.GunNetFilterOrder;
 import top.gunplan.netty.common.GunNettyPropertyManager;
-import top.gunplan.netty.impl.GunRequestFilterDto;
+import top.gunplan.netty.impl.GunInputFilterChecker;
 import top.gunplan.netty.impl.example.GunOutputFilterDto;
 import top.gunplan.netty.protocol.GunHttp2InputProtocl;
 
 @GunNetFilterOrder(index = 2)
 public class GunHttpdHostCheck implements GunNettyFilter {
     @Override
-    public DealResult doInputFilter(GunRequestFilterDto filterDto) {
+    public DealResult doInputFilter(GunInputFilterChecker filterDto) {
         GunHttp2InputProtocl httpmessage = (GunHttp2InputProtocl) filterDto.getObject();
         return httpmessage.getRequstHead().get("Host").equals(GunNettyPropertyManager.getHttp().getHttphost()) ? DealResult.NEXT : DealResult.NOTDEALALLNEXT;
     }

src/top/gunplan/netty/filters/GunNettyStdFirstFilter.java

@@ -4,7 +4,7 @@
 import top.gunplan.netty.anno.GunNetFilterOrder;
 import top.gunplan.netty.common.GunNettyPropertyManager;
 import top.gunplan.netty.impl.CunCoreDataEventLoop;
-import top.gunplan.netty.impl.GunRequestFilterDto;
+import top.gunplan.netty.impl.GunInputFilterChecker;
 import top.gunplan.netty.impl.example.GunOutputFilterDto;
 import top.gunplan.utils.AbstractGunBaseLogUtil;
 import top.gunplan.utils.GunBytesUtil;
@@ -29,7 +29,7 @@ private void dealCloseEvent(SelectionKey key) throws IOException {
     }
 
     @Override
-    public DealResult doInputFilter(GunRequestFilterDto filterDto) throws Exception {
+    public DealResult doInputFilter(GunInputFilterChecker filterDto) throws Exception {
         byte[] readbata;
         SelectionKey key = filterDto.getKey();
 

src/top/gunplan/netty/filters/GunStdHttp2Filter.java

@@ -1,6 +1,6 @@
 package top.gunplan.netty.filters;
 
-import top.gunplan.netty.impl.GunRequestFilterDto;
+import top.gunplan.netty.impl.GunInputFilterChecker;
 import top.gunplan.netty.GunNettyFilter;
 import top.gunplan.netty.impl.example.GunOutputFilterDto;
 import top.gunplan.netty.anno.GunNetFilterOrder;
@@ -13,7 +13,7 @@
 @GunNetFilterOrder(index = 1)
 public class GunStdHttp2Filter implements GunNettyFilter {
     @Override
-    public DealResult doInputFilter(GunRequestFilterDto filterDto) {
+    public DealResult doInputFilter(GunInputFilterChecker filterDto) {
         GunNetInputInterface protocl = new GunHttp2InputProtocl();
         protocl.unSerialize(filterDto.getSrc());
         filterDto.setObject(protocl);

src/top/gunplan/netty/filters/GunStdToStringFilter.java

@@ -1,7 +1,7 @@
 package top.gunplan.netty.filters;
 
 import top.gunplan.netty.GunNettyFilter;
-import top.gunplan.netty.impl.GunRequestFilterDto;
+import top.gunplan.netty.impl.GunInputFilterChecker;
 import top.gunplan.netty.impl.example.GunOutputFilterDto;
 import top.gunplan.netty.anno.GunNetFilterOrder;
 import top.gunplan.netty.protocol.GunStdString;
@@ -12,7 +12,7 @@
 @GunNetFilterOrder
 public class GunStdToStringFilter implements GunNettyFilter {
     @Override
-    public DealResult doInputFilter(GunRequestFilterDto filterDto) {
+    public DealResult doInputFilter(GunInputFilterChecker filterDto) {
         GunStdString s = new GunStdString();
         s.unSerialize(filterDto.getSrc());
         filterDto.setObject(s);

src/top/gunplan/netty/impl/GunCoreCalculatorWorker.java

@@ -26,7 +26,7 @@ public final class GunCoreCalculatorWorker extends BaseGunNettyWorker {
 
     @Override
     public synchronized void run() {
-        final GunRequestFilterDto gunFilterObj = new GunRequestFilterDto(key);
+        final GunInputFilterChecker gunFilterObj = new GunInputFilterChecker(key);
         for (GunNettyFilter filter : this.pileline.getFilters()) {
             GunNettyFilter.DealResult result = null;
             try {

src/top/gunplan/netty/impl/GunRequestFilterDto.java renamed to src/top/gunplan/netty/impl/GunInputFilterChecker.java

@@ -11,13 +11,13 @@
 /**
  * @author dosdrtt
  */
-public final class GunRequestFilterDto {
+public final class GunInputFilterChecker {
     private SelectionKey key;
     private AtomicInteger size;
 
 
 
-    public GunRequestFilterDto(SelectionKey key) {
+    public GunInputFilterChecker(SelectionKey key) {
         this.key = key;
         this.size = size;
     }
@@ -49,7 +49,7 @@ public GunNetInputInterface getObject() {
         return object;
     }
 
-    public GunRequestFilterDto(@NotNull byte[] src, GunNetInputInterface object) {
+    public GunInputFilterChecker(@NotNull byte[] src, GunNetInputInterface object) {
         this.src = src;
         this.object = object;
     }

src/top/gunplan/netty/protocol/package-info.java

@@ -0,0 +1,6 @@
+package top.gunplan.netty.protocol;
+/**
+ all of class in {@link top.gunplan.netty.protocol} is thread safe
+ because it was not used by mult thread
+ **/
+