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;
17  
18  
19  import io.netty.util.concurrent.Future;
20  
21  /**
22   * {@link EventLoop} that allows to register / deregister {@link IoHandle} instances.
23   */
24  public interface IoEventLoop extends EventLoop, IoEventLoopGroup {
25  
26      @Override
27      default IoEventLoop next() {
28          return this;
29      }
30  
31      /**
32       * Register the {@link IoHandle} to the {@link EventLoop} for I/O processing.
33       *
34       * @param handle        the {@link IoHandle} to register.
35       * @return              the {@link Future} that is notified once the operations completes.
36       */
37      Future<IoRegistration> register(IoHandle handle);
38  
39      // Force sub-classes to implement.
40      @Override
41      boolean isCompatible(Class<? extends IoHandle> handleType);
42  
43      // Force sub-classes to implement.
44      @Override
45      boolean isIoType(Class<? extends IoHandler> handlerType);
46  }