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  package org.apache.mina.api;
20  
21  /**
22   * A listener that asynchronously receives the result of a future computation.
23   * The listeners will be called from an event pool and so any amount of
24   * significant work should not be done in this listener.
25   *
26   * @author <a href="http://mina.apache.org">Apache MINA Project</a>
27   */
28  public interface IoFutureListener<V> {
29  
30      /**
31       * Called if there was an exception by the task as it was executing.
32       * Expect {@link java.util.concurrent.CancellationException} of the
33       * future was canceled or {@link java.util.concurrent.ExecutionException}
34       * if there was an error executing the task the future was waiting on.
35       *
36       * @param t an instance of {@link Throwable}
37       */
38      void exception(Throwable t);
39  
40      /**
41       * Called when the task has completed.  This method provides the result
42       * returned by the task.
43       *
44       * @param result the result returned by the task.
45       */
46      void completed(V result);
47  }