org.apache.mina.core.future

类 DefaultReadFuture

java.lang.Object

org.apache.mina.core.future.DefaultIoFuture

org.apache.mina.core.future.DefaultReadFuture

所有已实现的接口:

IoFuture, ReadFuture

public class DefaultReadFuture
extends DefaultIoFuture
implements ReadFuture

A default implementation of WriteFuture.

作者:

Apache MINA Project

构造器概要

构造器

构造器和说明
DefaultReadFuture(IoSession session) Creates a new instance.

方法概要

方法

限定符和类型	方法和说明
ReadFuture	addListener(IoFutureListener<?> listener) Adds an event listener which is notified when this future is completed.
ReadFuture	await() Wait for the asynchronous operation to complete.
ReadFuture	awaitUninterruptibly() Wait for the asynchronous operation to complete uninterruptibly.
java.lang.Throwable	getException()
java.lang.Object	getMessage() Get the read message.
boolean	isClosed()
boolean	isRead()
ReadFuture	removeListener(IoFutureListener<?> listener) Removes an existing event listener so it won't be notified when the future is completed.
void	setClosed() Sets the associated IoSession is closed.
void	setException(java.lang.Throwable exception) Sets the cause of the read failure, and notifies all threads waiting for this future.
void	setRead(java.lang.Object message) Sets the message is written, and notifies all threads waiting for this future.

从类继承的方法 org.apache.mina.core.future.DefaultIoFuture

await, await, awaitUninterruptibly, awaitUninterruptibly, getSession, getValue, isDone, join, join, setValue

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

构造器详细资料

DefaultReadFuture

public DefaultReadFuture(IoSession session)

Creates a new instance.

参数:

session - The associated session

方法详细资料

getMessage

public java.lang.Object getMessage()

Get the read message.

指定者:

getMessage 在接口中 ReadFuture

返回:

the received message. It returns null if this future is not ready or the associated IoSession has been closed.

isRead

public boolean isRead()

指定者:

isRead 在接口中 ReadFuture

返回:

true if a message was received successfully.

isClosed

public boolean isClosed()

指定者:

isClosed 在接口中 ReadFuture

返回:

true if the IoSession associated with this future has been closed.

getException

public java.lang.Throwable getException()

指定者:

getException 在接口中 ReadFuture

返回:

the cause of the read failure if and only if the read operation has failed due to an Exception. Otherwise, null is returned.

setClosed

public void setClosed()

Sets the associated IoSession is closed. This method is invoked by MINA internally. Please do not call this method directly.

指定者:

setClosed 在接口中 ReadFuture

setRead

public void setRead(java.lang.Object message)

Sets the message is written, and notifies all threads waiting for this future. This method is invoked by MINA internally. Please do not call this method directly.

指定者:

setRead 在接口中 ReadFuture

参数:

message - The received message to store in this future

setException

public void setException(java.lang.Throwable exception)

Sets the cause of the read failure, and notifies all threads waiting for this future. This method is invoked by MINA internally. Please do not call this method directly.

指定者:

setException 在接口中 ReadFuture

参数:

exception - The exception to store in the Future instance

await

public ReadFuture 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

指定者:

await 在接口中 ReadFuture

覆盖:

await 在类中 DefaultIoFuture

返回:

The instance of IoFuture that we are waiting for

抛出:

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

awaitUninterruptibly

public ReadFuture awaitUninterruptibly()

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

指定者:

awaitUninterruptibly 在接口中 IoFuture

指定者:

awaitUninterruptibly 在接口中 ReadFuture

覆盖:

awaitUninterruptibly 在类中 DefaultIoFuture

返回:

the current IoFuture

addListener

public ReadFuture 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

指定者:

addListener 在接口中 ReadFuture

覆盖:

addListener 在类中 DefaultIoFuture

参数:

listener - The listener to add

返回:

the current IoFuture

removeListener

public ReadFuture removeListener(IoFutureListener<?> listener)

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

指定者:

removeListener 在接口中 IoFuture

指定者:

removeListener 在接口中 ReadFuture

覆盖:

removeListener 在类中 DefaultIoFuture

参数:

listener - The listener to remove

返回:

the current IoFuture