org.apache.mina.core.future.IoFuture Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*/
package org.apache.mina.core.future;
import java.util.concurrent.TimeUnit;
import org.apache.mina.core.session.IoSession;
/**
* Represents the completion of an asynchronous I/O operation on an
* {@link IoSession}.
* Can be listened for completion using a {@link IoFutureListener}.
*
* @author Apache MINA Project
*/
public interface IoFuture {
/**
* @return the {@link IoSession} which is associated with this future.
*/
IoSession getSession();
/**
* Wait for the asynchronous operation to complete.
* The attached listeners will be notified when the operation is
* completed.
*
* @return The instance of IoFuture that we are waiting for
* @exception InterruptedException If the thread is interrupted while waiting
*/
IoFuture await() throws InterruptedException;
/**
* Wait for the asynchronous operation to complete with the specified timeout.
*
* @param timeout The maximum delay to wait before getting out
* @param unit the type of unit for the delay (seconds, minutes...)
* @return true if the operation is completed.
* @exception InterruptedException If the thread is interrupted while waiting
*/
boolean await(long timeout, TimeUnit unit) throws InterruptedException;
/**
* Wait for the asynchronous operation to complete with the specified timeout.
*
* @param timeoutMillis The maximum milliseconds to wait before getting out
* @return true if the operation is completed.
* @exception InterruptedException If the thread is interrupted while waiting
*/
boolean await(long timeoutMillis) throws InterruptedException;
/**
* Wait for the asynchronous operation to complete uninterruptibly.
* The attached listeners will be notified when the operation is
* completed.
*
* @return the current IoFuture
*/
IoFuture awaitUninterruptibly();
/**
* Wait for the asynchronous operation to complete with the specified timeout
* uninterruptibly.
*
* @param timeout The maximum delay to wait before getting out
* @param unit the type of unit for the delay (seconds, minutes...)
* @return true if the operation is completed.
*/
boolean awaitUninterruptibly(long timeout, TimeUnit unit);
/**
* Wait for the asynchronous operation to complete with the specified timeout
* uninterruptibly.
*
* @param timeoutMillis The maximum milliseconds to wait before getting out
* @return true if the operation is finished.
*/
boolean awaitUninterruptibly(long timeoutMillis);
/**
* @deprecated Replaced with {@link #awaitUninterruptibly()}.
*/
@Deprecated
void join();
/**
* @deprecated Replaced with {@link #awaitUninterruptibly(long)}.
*
* @param timeoutMillis The time to wait for the join before bailing out
* @return true if the join was successful
*/
@Deprecated
boolean join(long timeoutMillis);
/**
* @return true if the operation is completed.
*/
boolean isDone();
/**
* Adds an event listener which is notified when
* this future is completed. If the listener is added
* after the completion, the listener is directly notified.
*
* @param listener The listener to add
* @return the current IoFuture
*/
IoFuture addListener(IoFutureListener listener);
/**
* Removes an existing event listener so it won't be notified when
* the future is completed.
*
* @param listener The listener to remove
* @return the current IoFuture
*/
IoFuture removeListener(IoFutureListener listener);
}