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 * The execution context for an {@link IoHandler}.
20 * All methods must be called from the {@link IoEventLoop} thread.
21 */
22 public interface IoExecutionContext {
23 /**
24 * Returns {@code true} if blocking for IO is allowed or if we should try to do a non-blocking request for IO to be
25 * ready.
26 *
27 * @return {@code true} if allowed, {@code false} otherwise.
28 */
29 boolean canBlock();
30
31 /**
32 * Returns the amount of time left until the scheduled task with the closest deadline should run.
33 *
34 * @param currentTimeNanos the current nanos.
35 * @return nanos
36 */
37 long delayNanos(long currentTimeNanos);
38
39 /**
40 * Returns the absolute point in time at which the next
41 * closest scheduled task should run or {@code -1} if nothing is scheduled to run.
42 *
43 * @return deadline.
44 */
45 long deadlineNanos();
46 }