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 *
30 * // Wait until the connection is closed
31 * future.awaitUninterruptibly();
32 *
33 * // Now connection should be closed.
34 * assert future.isClosed();
35 * </pre>
36 *
37 * @author <a href="http://mina.apache.org">Apache MINA Project</a>
38 */
39 public interface CloseFuture extends IoFuture {
40 /**
41 * @return <tt>true</tt> if the close request is finished and the session is closed.
42 */
43 boolean isClosed();
44
45 /**
46 * Marks this future as closed and notifies all threads waiting for this
47 * future. This method is invoked by MINA internally. Please do not call
48 * this method directly.
49 */
50 void setClosed();
51
52 /**
53 * {@inheritDoc}
54 */
55 @Override
56 CloseFuture await() throws InterruptedException;
57
58 /**
59 * {@inheritDoc}
60 */
61 @Override
62 CloseFuture awaitUninterruptibly();
63
64 /**
65 * {@inheritDoc}
66 */
67 @Override
68 CloseFuture addListener(IoFutureListener<?> listener);
69
70 /**
71 * {@inheritDoc}
72 */
73 @Override
74 CloseFuture removeListener(IoFutureListener<?> listener);
75 }