Fix visibility and make it possible to decorate IoRegistration sub-cl…

…asses
netty · Apr 27, 2024 · aa7c143 · aa7c143
1 parent d1db017
commit aa7c143
Show file tree

Hide file tree

Showing 17 changed files with 50 additions and 90 deletions.
diff --git a/transport-classes-epoll/src/main/java/io/netty/channel/epoll/AbstractEpollChannel.java b/transport-classes-epoll/src/main/java/io/netty/channel/epoll/AbstractEpollChannel.java
@@ -404,7 +404,7 @@ final long doWriteOrSendBytes(ByteBuf data, InetSocketAddress remoteAddress, boo
         }
 
         if (data.nioBufferCount() > 1) {
-            IovArray array = ((EpollInternalIoRegistration) registration()).cleanIovArray();
+            IovArray array = registration().ioHandler().cleanIovArray();
             array.add(data, data.readerIndex(), data.readableBytes());
             int cnt = array.count();
             assert cnt != 0;

diff --git a/transport-classes-epoll/src/main/java/io/netty/channel/epoll/AbstractEpollStreamChannel.java b/transport-classes-epoll/src/main/java/io/netty/channel/epoll/AbstractEpollStreamChannel.java
@@ -501,7 +501,7 @@ protected int doWriteSingle(ChannelOutboundBuffer in) throws Exception {
      */
     private int doWriteMultiple(ChannelOutboundBuffer in) throws Exception {
         final long maxBytesPerGatheringWrite = config().getMaxBytesPerGatheringWrite();
-        IovArray array = ((EpollInternalIoRegistration) registration()).cleanIovArray();
+        IovArray array = registration().ioHandler().cleanIovArray();
         array.maxBytes(maxBytesPerGatheringWrite);
         in.forEachFlushedMessage(array);
 

diff --git a/transport-classes-epoll/src/main/java/io/netty/channel/epoll/EpollDatagramChannel.java b/transport-classes-epoll/src/main/java/io/netty/channel/epoll/EpollDatagramChannel.java
@@ -774,6 +774,6 @@ private boolean scatteringRead(EpollRecvByteAllocatorHandle allocHandle, NativeD
     }
 
     private NativeDatagramPacketArray cleanDatagramPacketArray() {
-        return ((EpollInternalIoRegistration) registration()).cleanDatagramPacketArray();
+        return registration().ioHandler().cleanDatagramPacketArray();
     }
 }
diff --git a/transport-classes-epoll/src/main/java/io/netty/channel/epoll/EpollDomainDatagramChannel.java b/transport-classes-epoll/src/main/java/io/netty/channel/epoll/EpollDomainDatagramChannel.java
@@ -183,7 +183,7 @@ private boolean doWriteMessage(Object msg) throws Exception {
                         remoteAddress.path().getBytes(CharsetUtil.UTF_8));
             }
         } else if (data.nioBufferCount() > 1) {
-            IovArray array = ((EpollInternalIoRegistration) registration()).cleanIovArray();
+            IovArray array = registration().ioHandler().cleanIovArray();
             array.add(data, data.readerIndex(), data.readableBytes());
             int cnt = array.count();
             assert cnt != 0;

diff --git a/...sport-classes-epoll/src/main/java/io/netty/channel/epoll/EpollInternalIoRegistration.java b/...sport-classes-epoll/src/main/java/io/netty/channel/epoll/EpollInternalIoRegistration.java
diff --git a/transport-classes-epoll/src/main/java/io/netty/channel/epoll/EpollIoHandler.java b/transport-classes-epoll/src/main/java/io/netty/channel/epoll/EpollIoHandler.java
@@ -24,7 +24,6 @@
 import io.netty.channel.IoHandler;
 import io.netty.channel.IoHandlerFactory;
 import io.netty.channel.IoOpt;
-import io.netty.channel.IoRegistration;
 import io.netty.channel.SelectStrategy;
 import io.netty.channel.SelectStrategyFactory;
 import io.netty.channel.unix.FileDescriptor;
@@ -257,7 +256,7 @@ public void destroy() {
         }
     }
 
-    private final class DefaultEpollIoRegistration extends AtomicBoolean implements EpollInternalIoRegistration {
+    private final class DefaultEpollIoRegistration extends AtomicBoolean implements EpollIoRegistration {
         private final IoEventLoop eventLoop;
         final EpollIoHandle handle;
 
@@ -269,18 +268,6 @@ private final class DefaultEpollIoRegistration extends AtomicBoolean implements
             this.currentOpt = initialOpt;
         }
 
-        @Override
-        public IovArray cleanIovArray() {
-            assert eventLoop.inEventLoop();
-            return EpollIoHandler.this.cleanIovArray();
-        }
-
-        @Override
-        public NativeDatagramPacketArray cleanDatagramPacketArray() {
-            assert eventLoop.inEventLoop();
-            return EpollIoHandler.this.cleanDatagramPacketArray();
-        }
-
         @Override
         public void updateInterestOpt(EpollIoOpt opt) throws IOException {
             currentOpt = opt;
@@ -301,6 +288,11 @@ public EpollIoOpt interestOpt() {
             return currentOpt;
         }
 
+        @Override
+        public EpollIoHandler ioHandler() {
+            return EpollIoHandler.this;
+        }
+
         @Override
         public boolean isValid() {
             return !get();
@@ -355,8 +347,8 @@ void handle(long ev) {
     }
 
     @Override
-    public IoRegistration register(IoEventLoop eventLoop, IoHandle handle,
-                                                                   IoOpt initialOpt)
+    public EpollIoRegistration register(IoEventLoop eventLoop, IoHandle handle,
+                                      IoOpt initialOpt)
             throws Exception {
         final EpollIoHandle epollHandle = cast(handle);
         EpollIoOpt opt = cast(initialOpt);

diff --git a/transport-classes-epoll/src/main/java/io/netty/channel/epoll/EpollIoRegistration.java b/transport-classes-epoll/src/main/java/io/netty/channel/epoll/EpollIoRegistration.java
@@ -39,4 +39,7 @@ public interface EpollIoRegistration extends IoRegistration {
 
     @Override
     void cancel() throws IOException;
+
+    @Override
+    EpollIoHandler ioHandler();
 }
diff --git a/...ort-classes-kqueue/src/main/java/io/netty/channel/kqueue/AbstractKQueueStreamChannel.java b/...ort-classes-kqueue/src/main/java/io/netty/channel/kqueue/AbstractKQueueStreamChannel.java
@@ -347,7 +347,7 @@ protected int doWriteSingle(ChannelOutboundBuffer in) throws Exception {
      */
     private int doWriteMultiple(ChannelOutboundBuffer in) throws Exception {
         final long maxBytesPerGatheringWrite = config().getMaxBytesPerGatheringWrite();
-        IovArray array = ((KQueueInternalIoRegistration) registration()).cleanArray();
+        IovArray array = registration().ioHandler().cleanArray();
         array.maxBytes(maxBytesPerGatheringWrite);
         in.forEachFlushedMessage(array);
 

diff --git a/transport-classes-kqueue/src/main/java/io/netty/channel/kqueue/KQueueDatagramChannel.java b/transport-classes-kqueue/src/main/java/io/netty/channel/kqueue/KQueueDatagramChannel.java
@@ -273,7 +273,7 @@ protected boolean doWriteMessage(Object msg) throws Exception {
                         remoteAddress.getAddress(), remoteAddress.getPort());
             }
         } else if (data.nioBufferCount() > 1) {
-            IovArray array = ((KQueueInternalIoRegistration) registration()).cleanArray();
+            IovArray array = registration().ioHandler().cleanArray();
             array.add(data, data.readerIndex(), data.readableBytes());
             int cnt = array.count();
             assert cnt != 0;

diff --git a/...ort-classes-kqueue/src/main/java/io/netty/channel/kqueue/KQueueDomainDatagramChannel.java b/...ort-classes-kqueue/src/main/java/io/netty/channel/kqueue/KQueueDomainDatagramChannel.java
@@ -137,7 +137,7 @@ protected boolean doWriteMessage(Object msg) throws Exception {
                         remoteAddress.path().getBytes(CharsetUtil.UTF_8));
             }
         } else if (data.nioBufferCount() > 1) {
-            IovArray array = ((KQueueInternalIoRegistration) registration()).cleanArray();
+            IovArray array = registration().ioHandler().cleanArray();
             array.add(data, data.readerIndex(), data.readableBytes());
             int cnt = array.count();
             assert cnt != 0;

diff --git a/...rt-classes-kqueue/src/main/java/io/netty/channel/kqueue/KQueueInternalIoRegistration.java b/...rt-classes-kqueue/src/main/java/io/netty/channel/kqueue/KQueueInternalIoRegistration.java
diff --git a/transport-classes-kqueue/src/main/java/io/netty/channel/kqueue/KQueueIoHandler.java b/transport-classes-kqueue/src/main/java/io/netty/channel/kqueue/KQueueIoHandler.java
@@ -47,9 +47,9 @@
 import static java.lang.Math.min;
 
 /**
- * {@link EventLoop} which uses kqueue under the covers. Only works on BSD!
+ * {@link IoHandler} which uses kqueue under the covers. Only works on BSD!
  */
-final class KQueueIoHandler implements IoHandler {
+public final class KQueueIoHandler implements IoHandler {
     private static final InternalLogger logger = InternalLoggerFactory.getInstance(KQueueIoHandler.class);
     private static final AtomicIntegerFieldUpdater<KQueueIoHandler> WAKEN_UP_UPDATER =
             AtomicIntegerFieldUpdater.newUpdater(KQueueIoHandler.class, "wakenUp");
@@ -125,7 +125,7 @@ private KQueueIoHandler(int maxEvents, SelectStrategy strategy) {
     /**
      * Return a cleared {@link IovArray} that can be used for writes in this {@link EventLoop}.
      */
-    private IovArray cleanArray() {
+    IovArray cleanArray() {
         iovArray.clear();
         return iovArray;
     }
@@ -325,8 +325,7 @@ public void destroy() {
     }
 
     @Override
-    public IoRegistration register(IoEventLoop eventLoop, IoHandle handle,
-                                                                   IoOpt initialOpts) {
+    public KQueueIoRegistration register(IoEventLoop eventLoop, IoHandle handle, IoOpt initialOpts) {
         final KQueueIoHandle kqueueHandle = cast(handle);
         if (kqueueHandle.ident() == KQUEUE_WAKE_UP_IDENT) {
             throw new IllegalArgumentException("ident " + KQUEUE_WAKE_UP_IDENT + " is reserved for internal usage");
@@ -367,8 +366,8 @@ public boolean isCompatible(Class<? extends IoHandle> handleType) {
         return KQueueIoHandle.class.isAssignableFrom(handleType);
     }
 
-    private final class DefaultKqueueIoRegistration extends AtomicBoolean implements KQueueInternalIoRegistration {
-        private final KQueueEventIoOpt readyEventIoOpt = new KQueueEventIoOpt();;
+    private final class DefaultKqueueIoRegistration extends AtomicBoolean implements KQueueIoRegistration {
+        private final KQueueEventIoOpt readyEventIoOpt = new KQueueEventIoOpt();
 
         final KQueueIoHandle handle;
 
@@ -395,8 +394,8 @@ public void addOpt(KQueueEventIoOpt opt) {
         }
 
         @Override
-        public IovArray cleanArray() {
-            return KQueueIoHandler.this.cleanArray();
+        public KQueueIoHandler ioHandler() {
+            return KQueueIoHandler.this;
         }
 
         void handle(int ident, short filter, short flags, int fflags, long data) {

diff --git a/transport-classes-kqueue/src/main/java/io/netty/channel/kqueue/KQueueIoRegistration.java b/transport-classes-kqueue/src/main/java/io/netty/channel/kqueue/KQueueIoRegistration.java
@@ -28,4 +28,7 @@ public interface KQueueIoRegistration extends IoRegistration {
      * @param opt   the {@link KQueueEventIoOpt} to use.
      */
     void addOpt(KQueueEventIoOpt opt);
+
+    @Override
+    KQueueIoHandler ioHandler();
 }
diff --git a/transport/src/main/java/io/netty/channel/IoRegistration.java b/transport/src/main/java/io/netty/channel/IoRegistration.java
@@ -33,4 +33,11 @@ public interface IoRegistration {
      * Cancel the registration.
      */
     void cancel() throws Exception;
+
+    /**
+     * The {@link IoHandler} to which this {@link IoRegistration} belongs too.
+     *
+     * @return  ioHandler.
+     */
+    IoHandler ioHandler();
 }
diff --git a/transport/src/main/java/io/netty/channel/local/LocalIoHandler.java b/transport/src/main/java/io/netty/channel/local/LocalIoHandler.java
@@ -140,5 +140,10 @@ private void cancel0() {
                 handle.deregisterNow();
             }
         }
+
+        @Override
+        public IoHandler ioHandler() {
+            return LocalIoHandler.this;
+        }
     }
 }
diff --git a/transport/src/main/java/io/netty/channel/nio/NioIoHandler.java b/transport/src/main/java/io/netty/channel/nio/NioIoHandler.java
@@ -23,7 +23,6 @@
 import io.netty.channel.IoHandler;
 import io.netty.channel.IoHandlerFactory;
 import io.netty.channel.IoOpt;
-import io.netty.channel.IoRegistration;
 import io.netty.channel.SelectStrategy;
 import io.netty.channel.SelectStrategyFactory;
 import io.netty.util.IntSupplier;
@@ -377,10 +376,15 @@ void close() {
         void handle(int ready) {
             handle.handle(this, NioIoOpt.valueOf(ready));
         }
+
+        @Override
+        public NioIoHandler ioHandler() {
+            return NioIoHandler.this;
+        }
     }
 
     @Override
-    public IoRegistration register(IoEventLoop eventLoop, IoHandle handle, IoOpt initialOpt)
+    public NioIoRegistration register(IoEventLoop eventLoop, IoHandle handle, IoOpt initialOpt)
             throws Exception {
         NioHandle nioHandle = nioHandle(handle);
         NioIoOpt opt = cast(initialOpt);

diff --git a/transport/src/main/java/io/netty/channel/nio/NioIoRegistration.java b/transport/src/main/java/io/netty/channel/nio/NioIoRegistration.java
@@ -46,4 +46,7 @@ public interface NioIoRegistration extends IoRegistration {
 
     @Override
     void cancel();
+
+    @Override
+    NioIoHandler ioHandler();
 }