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.core.future;
    21
    22  import java.util.EventListener;
    23
    24  import org.apache.mina.core.session.IoSession;
    25
    26  /**
    27   * Something interested in being notified when the completion
    28   * of an asynchronous I/O operation : {@link IoFuture}.
    29   *
    30   * @author <a href="http://mina.apache.org">Apache MINA Project</a>
    31   */
    32  public interface IoFutureListener<F extends IoFuture> extends EventListener {
    33      /**
    34       * An {@link IoFutureListener} that closes the {@link IoSession} which is
    35       * associated with the specified {@link IoFuture}.
    36       */
    37      static IoFutureListener<IoFuture> CLOSE = new IoFutureListener<IoFuture>() {
    38          public void operationComplete(IoFuture future) {
    39              future.getSession().close(true);
    40          }
    41      };
    42
    43      /**
    44       * Invoked when the operation associated with the {@link IoFuture}
    45       * has been completed even if you add the listener after the completion.
    46       *
    47       * @param future  The source {@link IoFuture} which called this
    48       *                callback.
    49       */
    50      void operationComplete(F future);
    51  }