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 /**
24 * An {@link IoFuture} for asynchronous close requests.
25 *
26 * <h3>Example</h3>
27 * <pre>
28 * IoSession session = ...;
29 * CloseFuture future = session.close(true);
30 * // Wait until the connection is closed
31 * future.awaitUninterruptibly();
32 * // Now connection should be closed.
33 * assert future.isClosed();
34 * </pre>
35 *
36 * @author <a href="http://mina.apache.org">Apache MINA Project</a>
37 */
38 public interface CloseFuture extends IoFuture {
39 /**
40 * Returns <tt>true</tt> if the close request is finished and the session is closed.
41 */
42 boolean isClosed();
43
44 /**
45 * Marks this future as closed and notifies all threads waiting for this
46 * future. This method is invoked by MINA internally. Please do not call
47 * this method directly.
48 */
49 void setClosed();
50
51 CloseFuture await() throws InterruptedException;
52
53 CloseFuture awaitUninterruptibly();
54
55 CloseFuture addListener(IoFutureListener<?> listener);
56
57 CloseFuture removeListener(IoFutureListener<?> listener);
58 }