org.apache.mina.core.future

类 DefaultIoFuture

java.lang.Object

org.apache.mina.core.future.DefaultIoFuture

所有已实现的接口:

IoFuture

直接已知子类:

AbstractIoService.ServiceOperationFuture, CompositeIoFuture, DefaultCloseFuture, DefaultConnectFuture, DefaultReadFuture, DefaultWriteFuture

public class DefaultIoFuture
extends java.lang.Object
implements IoFuture

A default implementation of IoFuture associated with an IoSession.

作者:

Apache MINA Project

构造器概要

构造器

构造器和说明
DefaultIoFuture(IoSession session) Creates a new instance associated with an IoSession.

方法概要

方法

限定符和类型	方法和说明
IoFuture	addListener(IoFutureListener<?> listener) Adds an event listener which is notified when this future is completed.
IoFuture	await() Wait for the asynchronous operation to complete.
boolean	await(long timeoutMillis) Wait for the asynchronous operation to complete with the specified timeout.
boolean	await(long timeout, java.util.concurrent.TimeUnit unit) Wait for the asynchronous operation to complete with the specified timeout.
IoFuture	awaitUninterruptibly() Wait for the asynchronous operation to complete uninterruptibly.
boolean	awaitUninterruptibly(long timeoutMillis) Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.
boolean	awaitUninterruptibly(long timeout, java.util.concurrent.TimeUnit unit) Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.
IoSession	getSession()
protected java.lang.Object	getValue()
boolean	isDone()
void	join() 已过时。 Replaced with awaitUninterruptibly().
boolean	join(long timeoutMillis) 已过时。 Replaced with awaitUninterruptibly(long).
IoFuture	removeListener(IoFutureListener<?> listener) Removes an existing event listener so it won't be notified when the future is completed.
boolean	setValue(java.lang.Object newValue) Sets the result of the asynchronous operation, and mark it as finished.

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

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

构造器详细资料

DefaultIoFuture

public DefaultIoFuture(IoSession session)

Creates a new instance associated with an IoSession.

参数:

session - an IoSession which is associated with this future

方法详细资料

getSession

public IoSession getSession()

指定者:

getSession 在接口中 IoFuture

返回:

the IoSession which is associated with this future.

join

@Deprecated
public void join()

已过时。 Replaced with awaitUninterruptibly().

指定者:

join 在接口中 IoFuture

join

@Deprecated
public boolean join(long timeoutMillis)

已过时。 Replaced with awaitUninterruptibly(long).

指定者:

join 在接口中 IoFuture

参数:

timeoutMillis - The time to wait for the join before bailing out

返回:

true if the join was successful

await

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

await

public boolean await(long timeout,
            java.util.concurrent.TimeUnit unit)
              throws java.lang.InterruptedException

Wait for the asynchronous operation to complete with the specified timeout.

指定者:

await 在接口中 IoFuture

参数:

timeout - The maximum delay to wait before getting out

unit - the type of unit for the delay (seconds, minutes...)

返回:

true if the operation is completed.

抛出:

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

await

public boolean await(long timeoutMillis)
              throws java.lang.InterruptedException

Wait for the asynchronous operation to complete with the specified timeout.

指定者:

await 在接口中 IoFuture

参数:

timeoutMillis - The maximum milliseconds to wait before getting out

返回:

true if the operation is completed.

抛出:

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

awaitUninterruptibly

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

awaitUninterruptibly

public boolean awaitUninterruptibly(long timeout,
                           java.util.concurrent.TimeUnit unit)

Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.

指定者:

awaitUninterruptibly 在接口中 IoFuture

参数:

timeout - The maximum delay to wait before getting out

unit - the type of unit for the delay (seconds, minutes...)

返回:

true if the operation is completed.

awaitUninterruptibly

public boolean awaitUninterruptibly(long timeoutMillis)

Wait for the asynchronous operation to complete with the specified timeout uninterruptibly.

指定者:

awaitUninterruptibly 在接口中 IoFuture

参数:

timeoutMillis - The maximum milliseconds to wait before getting out

返回:

true if the operation is finished.

isDone

public boolean isDone()

指定者:

isDone 在接口中 IoFuture

返回:

true if the operation is completed.

setValue

public boolean setValue(java.lang.Object newValue)

Sets the result of the asynchronous operation, and mark it as finished.

参数:

newValue - The result to store into the Future

返回:

true if the value has been set, false if the future already has a value (thus is in ready state)

getValue

protected java.lang.Object getValue()

返回:

the result of the asynchronous operation.

addListener

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

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