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.Set;
19 import java.util.concurrent.RejectedExecutionException;
20 import java.util.concurrent.TimeUnit;
21
22 /**
23 * Schedules {@link TimerTask}s for one-time future execution in a background
24 * thread.
25 */
26 public interface Timer {
27
28 /**
29 * Schedules the specified {@link TimerTask} for one-time execution after
30 * the specified delay.
31 *
32 * @return a handle which is associated with the specified task
33 *
34 * @throws IllegalStateException if this timer has been {@linkplain #stop() stopped} already
35 * @throws RejectedExecutionException if the pending timeouts are too many and creating new timeout
36 * can cause instability in the system.
37 */
38 Timeout newTimeout(TimerTask task, long delay, TimeUnit unit);
39
40 /**
41 * Releases all resources acquired by this {@link Timer} and cancels all
42 * tasks which were scheduled but not executed yet.
43 *
44 * @return the handles associated with the tasks which were canceled by
45 * this method
46 */
47 Set<Timeout> stop();
48 }