View Javadoc

1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License.
18   *
19   */
20  package org.apache.mina.core.future;
21  
22  /**
23   * An {@link IoFuture} for asynchronous close requests.
24   *
25   * <h3>Example</h3>
26   * <pre>
27   * IoSession session = ...;
28   * CloseFuture future = session.close(true);
29   * // Wait until the connection is closed
30   * future.awaitUninterruptibly();
31   * // Now connection should be closed.
32   * assert future.isClosed();
33   * </pre>
34   *
35   * @author <a href="http://mina.apache.org">Apache MINA Project</a>
36   */
37  public interface CloseFuture extends IoFuture {
38      /**
39       * Returns <tt>true</tt> if the close request is finished and the session is closed.
40       */
41      boolean isClosed();
42  
43      /**
44       * Marks this future as closed and notifies all threads waiting for this
45       * future.  This method is invoked by MINA internally.  Please do not call
46       * this method directly.
47       */
48      void setClosed();
49  
50      CloseFuture await() throws InterruptedException;
51  
52      CloseFuture awaitUninterruptibly();
53  
54      CloseFuture addListener(IoFutureListener<?> listener);
55  
56      CloseFuture removeListener(IoFutureListener<?> listener);
57  }