org.jboss.netty.channel

类 CompleteChannelFuture

java.lang.Object

org.jboss.netty.channel.CompleteChannelFuture

所有已实现的接口:

ChannelFuture

直接已知子类:

FailedChannelFuture, SucceededChannelFuture

public abstract class CompleteChannelFuture
extends java.lang.Object
implements ChannelFuture

A skeletal ChannelFuture implementation which represents a ChannelFuture which has been completed already.

构造器概要

构造器

限定符	构造器和说明
protected	CompleteChannelFuture(Channel channel) Creates a new instance.

方法概要

方法

限定符和类型	方法和说明
void	addListener(ChannelFutureListener listener) Adds the specified listener to this future.
ChannelFuture	await() Waits for this future to be completed.
boolean	await(long timeoutMillis) Waits for this future to be completed within the specified time limit.
boolean	await(long timeout, java.util.concurrent.TimeUnit unit) Waits for this future to be completed within the specified time limit.
ChannelFuture	awaitUninterruptibly() Waits for this future to be completed without interruption.
boolean	awaitUninterruptibly(long timeoutMillis) Waits for this future to be completed within the specified time limit without interruption.
boolean	awaitUninterruptibly(long timeout, java.util.concurrent.TimeUnit unit) Waits for this future to be completed within the specified time limit without interruption.
boolean	cancel() Cancels the I/O operation associated with this future and notifies all listeners if canceled successfully.
Channel	getChannel() Returns a channel where the I/O operation associated with this future takes place.
boolean	isCancelled() Returns true if and only if this future was cancelled by a ChannelFuture.cancel() method.
boolean	isDone() Returns true if and only if this future is complete, regardless of whether the operation was successful, failed, or cancelled.
void	removeListener(ChannelFutureListener listener) Removes the specified listener from this future.
boolean	setFailure(java.lang.Throwable cause) Marks this future as a failure and notifies all listeners.
boolean	setProgress(long amount, long current, long total) Notifies the progress of the operation to the listeners that implements ChannelFutureProgressListener.
boolean	setSuccess() Marks this future as a success and notifies all listeners.

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

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

从接口继承的方法 org.jboss.netty.channel.ChannelFuture

getCause, isSuccess, sync, syncUninterruptibly

构造器详细资料

CompleteChannelFuture

protected CompleteChannelFuture(Channel channel)

Creates a new instance.

参数:

channel - the Channel associated with this future

方法详细资料

addListener

public void addListener(ChannelFutureListener listener)

从接口复制的说明: ChannelFuture

Adds the specified listener to this future. The specified listener is notified when this future is done. If this future is already completed, the specified listener is notified immediately.

指定者:

addListener 在接口中 ChannelFuture

removeListener

public void removeListener(ChannelFutureListener listener)

从接口复制的说明: ChannelFuture

Removes the specified listener from this future. The specified listener is no longer notified when this future is done. If the specified listener is not associated with this future, this method does nothing and returns silently.

指定者:

removeListener 在接口中 ChannelFuture

await

public ChannelFuture await()
                    throws java.lang.InterruptedException

从接口复制的说明: ChannelFuture

Waits for this future to be completed.

指定者:

await 在接口中 ChannelFuture

抛出:

java.lang.InterruptedException - if the current thread was interrupted

await

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

从接口复制的说明: ChannelFuture

Waits for this future to be completed within the specified time limit.

指定者:

await 在接口中 ChannelFuture

返回:

true if and only if the future was completed within the specified time limit

抛出:

java.lang.InterruptedException - if the current thread was interrupted

await

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

从接口复制的说明: ChannelFuture

Waits for this future to be completed within the specified time limit.

指定者:

await 在接口中 ChannelFuture

返回:

true if and only if the future was completed within the specified time limit

抛出:

java.lang.InterruptedException - if the current thread was interrupted

awaitUninterruptibly

public ChannelFuture awaitUninterruptibly()

从接口复制的说明: ChannelFuture

Waits for this future to be completed without interruption. This method catches an InterruptedException and discards it silently.

指定者:

awaitUninterruptibly 在接口中 ChannelFuture

awaitUninterruptibly

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

从接口复制的说明: ChannelFuture

Waits for this future to be completed within the specified time limit without interruption. This method catches an InterruptedException and discards it silently.

指定者:

awaitUninterruptibly 在接口中 ChannelFuture

返回:

true if and only if the future was completed within the specified time limit

awaitUninterruptibly

public boolean awaitUninterruptibly(long timeoutMillis)

从接口复制的说明: ChannelFuture

Waits for this future to be completed within the specified time limit without interruption. This method catches an InterruptedException and discards it silently.

指定者:

awaitUninterruptibly 在接口中 ChannelFuture

返回:

true if and only if the future was completed within the specified time limit

getChannel

public Channel getChannel()

从接口复制的说明: ChannelFuture

Returns a channel where the I/O operation associated with this future takes place.

指定者:

getChannel 在接口中 ChannelFuture

isDone

public boolean isDone()

从接口复制的说明: ChannelFuture

Returns true if and only if this future is complete, regardless of whether the operation was successful, failed, or cancelled.

指定者:

isDone 在接口中 ChannelFuture

setProgress

public boolean setProgress(long amount,
                  long current,
                  long total)

从接口复制的说明: ChannelFuture

Notifies the progress of the operation to the listeners that implements ChannelFutureProgressListener. Please note that this method will not do anything and return false if this future is complete already.

指定者:

setProgress 在接口中 ChannelFuture

返回:

true if and only if notification was made.

setFailure

public boolean setFailure(java.lang.Throwable cause)

从接口复制的说明: ChannelFuture

Marks this future as a failure and notifies all listeners.

指定者:

setFailure 在接口中 ChannelFuture

返回:

true if and only if successfully marked this future as a failure. Otherwise false because this future is already marked as either a success or a failure.

setSuccess

public boolean setSuccess()

从接口复制的说明: ChannelFuture

Marks this future as a success and notifies all listeners.

指定者:

setSuccess 在接口中 ChannelFuture

返回:

true if and only if successfully marked this future as a success. Otherwise false because this future is already marked as either a success or a failure.

cancel

public boolean cancel()

从接口复制的说明: ChannelFuture

Cancels the I/O operation associated with this future and notifies all listeners if canceled successfully.

指定者:

cancel 在接口中 ChannelFuture

返回:

true if and only if the operation has been canceled. false if the operation can't be canceled or is already completed.

isCancelled

public boolean isCancelled()

从接口复制的说明: ChannelFuture

Returns true if and only if this future was cancelled by a ChannelFuture.cancel() method.

指定者:

isCancelled 在接口中 ChannelFuture