1 /*
2 * Copyright 2012 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.util;
17
18 import java.util.concurrent.TimeUnit;
19
20 /**
21 * A task which is executed after the delay specified with
22 * {@link Timer#newTimeout(TimerTask, long, TimeUnit)}.
23 */
24 public interface TimerTask {
25
26 /**
27 * Executed after the delay specified with
28 * {@link Timer#newTimeout(TimerTask, long, TimeUnit)}.
29 *
30 * @param timeout a handle which is associated with this task
31 */
32 void run(Timeout timeout) throws Exception;
33
34 /**
35 * Called for {@link TimerTask}s that are successfully canceled via {@link Timeout#cancel()}. Overriding this
36 * method allows to for example run some cleanup.
37 *
38 * @param timeout a handle which is associated with this task
39 */
40 default void cancelled(Timeout timeout) {
41 // By default do nothing.
42 }
43 }