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.ThreadAwareExecutor;
19 /**
20 * A handle that can be registered to a {@link IoHandler}.
21 * All methods must be called from the {@link ThreadAwareExecutor} thread (which means
22 * {@link ThreadAwareExecutor#isExecutorThread(Thread)} must return {@code true})
23 */
24 public interface IoHandle extends AutoCloseable {
25
26 /**
27 * Be called once there is something to handle.
28 *
29 * @param registration the {@link IoRegistration} for this {@link IoHandle}.
30 * @param ioEvent the {@link IoEvent} that must be handled. The {@link IoEvent} is only valid
31 * while this method is executed and so must not escape it.
32 */
33 void handle(IoRegistration registration, IoEvent ioEvent);
34 }