org.apache.mina.core.future

类 DefaultWriteFuture

java.lang.Object

org.apache.mina.core.future.DefaultIoFuture

org.apache.mina.core.future.DefaultWriteFuture

所有已实现的接口:

IoFuture, WriteFuture

public class DefaultWriteFuture
extends DefaultIoFuture
implements WriteFuture

A default implementation of WriteFuture.

作者:

Apache MINA Project

构造器概要

构造器

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

方法概要

方法

限定符和类型	方法和说明
WriteFuture	addListener(IoFutureListener<?> listener) Adds an event listener which is notified when this future is completed.
WriteFuture	await() Wait for the asynchronous operation to complete.
WriteFuture	awaitUninterruptibly() Wait for the asynchronous operation to complete uninterruptibly.
java.lang.Throwable	getException()
boolean	isWritten()
static WriteFuture	newNotWrittenFuture(IoSession session, java.lang.Throwable cause) Returns a new DefaultWriteFuture which is already marked as 'not written'.
static WriteFuture	newWrittenFuture(IoSession session) Returns a new DefaultWriteFuture which is already marked as 'written'.
WriteFuture	removeListener(IoFutureListener<?> listener) Removes an existing event listener so it won't be notified when the future is completed.
void	setException(java.lang.Throwable exception) Sets the cause of the write failure, and notifies all threads waiting for this future.
void	setWritten() 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

构造器详细资料

DefaultWriteFuture

public DefaultWriteFuture(IoSession session)

Creates a new instance.

参数:

session - The associated session

方法详细资料

newWrittenFuture

public static WriteFuture newWrittenFuture(IoSession session)

Returns a new DefaultWriteFuture which is already marked as 'written'.

参数:

session - The associated session

返回:

A new future for a written message

newNotWrittenFuture

public static WriteFuture newNotWrittenFuture(IoSession session,
                              java.lang.Throwable cause)

Returns a new DefaultWriteFuture which is already marked as 'not written'.

参数:

session - The associated session

cause - The reason why the message has not be written

返回:

A new future for not written message

isWritten

public boolean isWritten()

指定者:

isWritten 在接口中 WriteFuture

返回:

true if the write operation is finished successfully.

getException

public java.lang.Throwable getException()

指定者:

getException 在接口中 WriteFuture

返回:

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

setWritten

public void setWritten()

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.

指定者:

setWritten 在接口中 WriteFuture

setException

public void setException(java.lang.Throwable exception)

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

指定者:

setException 在接口中 WriteFuture

参数:

exception - The exception to store in the Future instance

await

public WriteFuture 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 在接口中 WriteFuture

覆盖:

await 在类中 DefaultIoFuture

返回:

The instance of IoFuture that we are waiting for

抛出:

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

awaitUninterruptibly

public WriteFuture awaitUninterruptibly()

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

指定者:

awaitUninterruptibly 在接口中 IoFuture

指定者:

awaitUninterruptibly 在接口中 WriteFuture

覆盖:

awaitUninterruptibly 在类中 DefaultIoFuture

返回:

the current IoFuture

addListener

public WriteFuture 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 在接口中 WriteFuture

覆盖:

addListener 在类中 DefaultIoFuture

参数:

listener - The listener to add

返回:

the current IoFuture

removeListener

public WriteFuture removeListener(IoFutureListener<?> listener)

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

指定者:

removeListener 在接口中 IoFuture

指定者:

removeListener 在接口中 WriteFuture

覆盖:

removeListener 在类中 DefaultIoFuture

参数:

listener - The listener to remove

返回:

the current IoFuture