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 // We only not return IoHandleEventLoopGroup here as this could break compat for people
27 // that extend EventLoopGroup implementations that now implement IoHandleEventLoop (for example NioEventLoop).
28 @Override
29 default EventLoopGroup parent() {
30 return this;
31 }
32 /**
33 * @deprecated Use {@link #register(IoHandle)}
34 */
35 @Deprecated
36 @Override
37 ChannelFuture register(Channel channel);
38
39 /**
40 * @deprecated Use {@link #register(IoHandle)}
41 */
42 @Deprecated
43 @Override
44 ChannelFuture register(ChannelPromise promise);
45
46 /**
47 * Register the {@link IoHandle} to the {@link EventLoop} for I/O processing.
48 *
49 * @param handle the {@link IoHandle} to register.
50 * @return the {@link Future} that is notified once the operations completes.
51 */
52 Future<IoRegistration> register(IoHandle handle);
53
54 // Force sub-classes to implement.
55 @Override
56 boolean isCompatible(Class<? extends IoHandle> handleType);
57
58 // Force sub-classes to implement.
59 @Override
60 boolean isIoType(Class<? extends IoHandler> handlerType);
61 }