1 /*
2 * Copyright 2018 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.netty5.util.concurrent;
17
18 /**
19 * A combination of {@link RunnableFuture} and {@link Comparable} (sorting by their next deadline),
20 * with additional methods for scheduling, periodicity, and delay.
21 */
22 public interface RunnableScheduledFuture<V> extends RunnableFuture<V>, Comparable<RunnableScheduledFuture<?>> {
23 /**
24 * Return {@code true} if the task is periodic, which means it may be executed multiple times, as opposed to a
25 * delayed task or a normal task, that only execute once.
26 *
27 * @return {@code true} if this task is periodic, otherwise {@code false}.
28 */
29 boolean isPeriodic();
30
31 /**
32 * Returns the deadline in nanos when the {@link #run()} method should be called again.
33 */
34 long deadlineNanos();
35
36 /**
37 * Returns the delay in nanos when the {@link #run()} method should be called again.
38 */
39 long delayNanos();
40
41 /**
42 * Returns the delay in nanos (taking the given {@code currentTimeNanos} into account) when the
43 * {@link #run()} method should be called again.
44 */
45 long delayNanos(long currentTimeNanos);
46
47 @Override
48 RunnableScheduledFuture<V> addListener(FutureListener<? super V> listener);
49
50 @Override
51 <C> RunnableScheduledFuture<V> addListener(C context, FutureContextListener<? super C, ? super V> listener);
52 }
53