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.common;
21
22 /**
23 * Represents the result of an ashynchronous I/O operation.
24 *
25 * @author The Apache Directory Project (mina-dev@directory.apache.org)
26 * @version $Rev: 599822 $, $Date: 2007-11-30 22:54:07 +0900 (Fri, 30 Nov 2007) $
27 */
28 public interface IoFuture {
29 /**
30 * Returns the {@link IoSession} which is associated with this future.
31 */
32 IoSession getSession();
33
34 /**
35 * Returns the lock object this future acquires.
36 */
37 Object getLock();
38
39 /**
40 * Wait for the asynchronous operation to end.
41 */
42 void join();
43
44 /**
45 * Wait for the asynchronous operation to end with the specified timeout.
46 *
47 * @return <tt>true</tt> if the operation is finished.
48 */
49 boolean join(long timeoutInMillis);
50
51 /**
52 * Returns if the asynchronous operation is finished.
53 */
54 boolean isReady();
55
56 /**
57 * Adds an event <tt>listener</tt> which is notified when
58 * the state of this future changes.
59 */
60 void addListener(IoFutureListener listener);
61
62 /**
63 * Removes an existing event <tt>listener</tt> which is notified when
64 * the state of this future changes.
65 */
66 void removeListener(IoFutureListener listener);
67 }