View Javadoc
1   /*
2    * Copyright 2024 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   https://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package io.netty.channel.nio;
17  
18  
19  import io.netty.channel.IoEvent;
20  import io.netty.channel.IoHandle;
21  import io.netty.channel.IoRegistration;
22  import io.netty.util.internal.ObjectUtil;
23  
24  import java.nio.channels.SelectableChannel;
25  import java.nio.channels.SelectionKey;
26  
27  /**
28   * Allows to create an {@link IoHandle} for a {@link SelectableChannel}, not necessarily created by Netty. This
29   * {@link IoHandle} can be used together with {@link NioIoHandler} and so have events dispatched for
30   * the {@link SelectableChannel}.
31   */
32  public abstract class NioSelectableChannelIoHandle<S extends SelectableChannel> implements IoHandle, NioIoHandle {
33      private final S channel;
34  
35      public NioSelectableChannelIoHandle(S channel) {
36          this.channel = ObjectUtil.checkNotNull(channel, "channel");
37      }
38  
39      @Override
40      public void handle(IoRegistration registration, IoEvent ioEvent) {
41          SelectionKey key = ((NioIoRegistration) registration).selectionKey();
42          NioSelectableChannelIoHandle.this.handle(channel, key);
43      }
44  
45      @Override
46      public void close() throws Exception {
47          channel.close();
48      }
49  
50      @Override
51      public SelectableChannel selectableChannel() {
52          return channel;
53      }
54  
55      protected abstract void handle(S channel, SelectionKey key);
56  
57      protected void deregister(S channel) {
58          // NOOP.
59      }
60  }