org.apache.mina.core.future

接口 CloseFuture

所有超级接口:

IoFuture

所有已知实现类:

DefaultCloseFuture

public interface CloseFuture
extends IoFuture

An IoFuture for asynchronous close requests.

Example

 IoSession session = ...;
 CloseFuture future = session.close(true);
 
 // Wait until the connection is closed
 future.awaitUninterruptibly();
 
 // Now connection should be closed.
 assert future.isClosed();
 

作者:

Apache MINA Project

方法概要

方法

限定符和类型	方法和说明
CloseFuture	addListener(IoFutureListener<?> listener) Adds an event listener which is notified when this future is completed.
CloseFuture	await() Wait for the asynchronous operation to complete.
CloseFuture	awaitUninterruptibly() Wait for the asynchronous operation to complete uninterruptibly.
boolean	isClosed()
CloseFuture	removeListener(IoFutureListener<?> listener) Removes an existing event listener so it won't be notified when the future is completed.
void	setClosed() Marks this future as closed and notifies all threads waiting for this future.

从接口继承的方法 org.apache.mina.core.future.IoFuture

await, await, awaitUninterruptibly, awaitUninterruptibly, getSession, isDone, join, join

方法详细资料

isClosed

boolean isClosed()

返回:

true if the close request is finished and the session is closed.

setClosed

void setClosed()

Marks this future as closed and notifies all threads waiting for this future. This method is invoked by MINA internally. Please do not call this method directly.

await

CloseFuture await()
                  throws java.lang.InterruptedException

Wait for the asynchronous operation to complete. The attached listeners will be notified when the operation is completed.

指定者:

await 在接口中 IoFuture

返回:

The instance of IoFuture that we are waiting for

抛出:

java.lang.InterruptedException - If the thread is interrupted while waiting

awaitUninterruptibly

CloseFuture awaitUninterruptibly()

Wait for the asynchronous operation to complete uninterruptibly. The attached listeners will be notified when the operation is completed.

指定者:

awaitUninterruptibly 在接口中 IoFuture

返回:

the current IoFuture

addListener

CloseFuture addListener(IoFutureListener<?> listener)

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.

指定者:

addListener 在接口中 IoFuture

参数:

listener - The listener to add

返回:

the current IoFuture

removeListener

CloseFuture removeListener(IoFutureListener<?> listener)

Removes an existing event listener so it won't be notified when the future is completed.

指定者:

removeListener 在接口中 IoFuture

参数:

listener - The listener to remove

返回:

the current IoFuture