View Javadoc

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    *   http://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  /**
19   * A handle associated with a {@link TimerTask} that is returned by a
20   * {@link Timer}.
21   */
22  public interface Timeout {
23  
24      /**
25       * Returns the {@link Timer} that created this handle.
26       */
27      Timer timer();
28  
29      /**
30       * Returns the {@link TimerTask} which is associated with this handle.
31       */
32      TimerTask task();
33  
34      /**
35       * Returns {@code true} if and only if the {@link TimerTask} associated
36       * with this handle has been expired.
37       */
38      boolean isExpired();
39  
40      /**
41       * Returns {@code true} if and only if the {@link TimerTask} associated
42       * with this handle has been cancelled.
43       */
44      boolean isCancelled();
45  
46      /**
47       * Attempts to cancel the {@link TimerTask} associated with this handle.
48       * If the task has been executed or cancelled already, it will return with
49       * no side effect.
50       *
51       * @return True if the cancellation completed successfully, otherwise false
52       */
53      boolean cancel();
54  }