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 import io.netty.util.concurrent.EventExecutor;
19 import io.netty.util.concurrent.Future;
20
21 import java.util.Iterator;
22
23 /**
24 * {@link EventLoopGroup} for {@link IoEventLoop}s.
25 */
26 public interface IoEventLoopGroup extends EventLoopGroup {
27
28 @Override
29 IoEventLoop next();
30
31 /**
32 * @deprecated Use {@link #register(IoHandle)}
33 */
34 @Deprecated
35 @Override
36 default ChannelFuture register(Channel channel) {
37 return next().register(channel);
38 }
39
40 /**
41 * @deprecated Use {@link #register(IoHandle)}
42 */
43 @Deprecated
44 @Override
45 default ChannelFuture register(ChannelPromise promise) {
46 return next().register(promise);
47 }
48
49 /**
50 * Register the {@link IoHandle} to the {@link EventLoop} for I/O processing.
51 *
52 * @param handle the {@link IoHandle} to register.
53 * @return the {@link Future} that is notified once the operations completes.
54 */
55 default Future<IoRegistration> register(IoHandle handle) {
56 return next().register(handle);
57 }
58
59 /**
60 * Returns {@code true} if the given type is compatible with this {@link IoEventLoopGroup} and so can be registered
61 * to the contained {@link IoEventLoop}s, {@code false} otherwise.
62 *
63 * @param handleType the type of the {@link IoHandle}.
64 * @return if compatible of not.
65 */
66 default boolean isCompatible(Class<? extends IoHandle> handleType) {
67 Iterator<EventExecutor> executors = iterator();
68 return executors.hasNext() && ((IoEventLoop) executors.next()).isCompatible(handleType);
69 }
70
71 /**
72 * Returns {@code true} if the given {@link IoHandler} type is used by this {@link IoEventLoopGroup},
73 * {@code false} otherwise.
74 *
75 * @param handlerType the type of the {@link IoHandler}.
76 * @return if used or not.
77 */
78 default boolean isIoType(Class<? extends IoHandler> handlerType) {
79 Iterator<EventExecutor> executors = iterator();
80 return executors.hasNext() && ((IoEventLoop) executors.next()).isIoType(handlerType);
81 }
82 }