KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > util > timeout > Timeout


1 /*
2  * JBoss, Home of Professional Open Source
3  * Copyright 2005, JBoss Inc., and individual contributors as indicated
4  * by the @authors tag. See the copyright.txt in the distribution for a
5  * full listing of individual contributors.
6  *
7  * This is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU Lesser General Public License as
9  * published by the Free Software Foundation; either version 2.1 of
10  * the License, or (at your option) any later version.
11  *
12  * This software is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this software; if not, write to the Free
19  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21  */
22 package org.jboss.util.timeout;
23
24 /**
25  * The public interface of timeouts.
26  *
27  * @author <a HREF="osh@sparre.dk">Ole Husgaard</a>
28  * @version $Revision: 1958 $
29 */
30 public interface Timeout
31 {
32    /**
33     * Cancel this timeout.
34     *
35     * It is guaranteed that on return from this method this timer is
36     * no longer active. This means that either it has been cancelled and
37     * the timeout will not happen, or (in case of late cancel) the
38     * timeout has happened and the timeout callback function has returned.
39     *
40     * On return from this method this instance should no longer be
41     * used. The reason for this is that an implementation may reuse
42     * cancelled timeouts, and at return the instance may already be
43     * in use for another timeout.
44     */
45    public boolean cancel();
46 }
Popular Tags