001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 *
019 */
020package org.apache.mina.core.future;
021
022import java.util.EventListener;
023
024import org.apache.mina.core.session.IoSession;
025
026/**
027 * Something interested in being notified when the completion
028 * of an asynchronous I/O operation : {@link IoFuture}. 
029 *
030 * @author <a href="http://mina.apache.org">Apache MINA Project</a>
031 */
032public interface IoFutureListener<F extends IoFuture> extends EventListener {
033    /**
034     * An {@link IoFutureListener} that closes the {@link IoSession} which is
035     * associated with the specified {@link IoFuture}.
036     */
037    IoFutureListener<IoFuture> CLOSE = new IoFutureListener<IoFuture>() {
038        public void operationComplete(IoFuture future) {
039            future.getSession().closeNow();
040        }
041    };
042
043    /**
044     * Invoked when the operation associated with the {@link IoFuture}
045     * has been completed even if you add the listener after the completion.
046     *
047     * @param future  The source {@link IoFuture} which called this
048     *                callback.
049     */
050    void operationComplete(F future);
051}