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.common;
    21
    22  import java.util.EventListener;
    23
    24  /**
    25   * Something interested in being notified when the result
    26   * of an {@link IoFuture} becomes available.
    27   *
    28   * @author The Apache Directory Project (mina-dev@directory.apache.org)
    29   * @version $Rev: 555855 $, $Date: 2007-07-13 12:19:00 +0900 (Fri, 13 Jul 2007) $
    30   */
    31  public interface IoFutureListener extends EventListener {
    32      /**
    33       * An {@link IoFutureListener} that closes the {@link IoSession} which is
    34       * associated with the specified {@link IoFuture}.
    35       */
    36      static IoFutureListener CLOSE = new IoFutureListener() {
    37          public void operationComplete(IoFuture future) {
    38              future.getSession().close();
    39          }
    40      };
    41
    42      /**
    43       * Invoked when the operation associated with the {@link IoFuture}
    44       * has been completed.
    45       *
    46       * @param future  The source {@link IoFuture} which called this
    47       *                callback.
    48       */
    49      void operationComplete(IoFuture future);
    50  }