public abstract class CompleteChannelFuture extends Object implements ChannelFuture
ChannelFuture
implementation which represents a
ChannelFuture
which has been completed already.Modifier | Constructor and Description |
---|---|
protected |
CompleteChannelFuture(Channel channel)
Creates a new instance.
|
Modifier and Type | Method and Description |
---|---|
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,
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,
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(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.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getCause, isSuccess, rethrowIfFailed, sync, syncUninterruptibly
public void addListener(ChannelFutureListener listener)
ChannelFuture
addListener
in interface ChannelFuture
public void removeListener(ChannelFutureListener listener)
ChannelFuture
removeListener
in interface ChannelFuture
public ChannelFuture await() throws InterruptedException
ChannelFuture
await
in interface ChannelFuture
InterruptedException
- if the current thread was interruptedpublic boolean await(long timeout, TimeUnit unit) throws InterruptedException
ChannelFuture
await
in interface ChannelFuture
true
if and only if the future was completed within
the specified time limitInterruptedException
- if the current thread was interruptedpublic boolean await(long timeoutMillis) throws InterruptedException
ChannelFuture
await
in interface ChannelFuture
true
if and only if the future was completed within
the specified time limitInterruptedException
- if the current thread was interruptedpublic ChannelFuture awaitUninterruptibly()
ChannelFuture
InterruptedException
and
discards it silently.awaitUninterruptibly
in interface ChannelFuture
public boolean awaitUninterruptibly(long timeout, TimeUnit unit)
ChannelFuture
InterruptedException
and discards it silently.awaitUninterruptibly
in interface ChannelFuture
true
if and only if the future was completed within
the specified time limitpublic boolean awaitUninterruptibly(long timeoutMillis)
ChannelFuture
InterruptedException
and discards it silently.awaitUninterruptibly
in interface ChannelFuture
true
if and only if the future was completed within
the specified time limitpublic Channel getChannel()
ChannelFuture
getChannel
in interface ChannelFuture
public boolean isDone()
ChannelFuture
true
if and only if this future is
complete, regardless of whether the operation was successful, failed,
or cancelled.isDone
in interface ChannelFuture
public boolean setProgress(long amount, long current, long total)
ChannelFuture
ChannelFutureProgressListener
. Please note that this method will
not do anything and return false
if this future is complete
already.setProgress
in interface ChannelFuture
true
if and only if notification was made.public boolean setFailure(Throwable cause)
ChannelFuture
setFailure
in interface 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.public boolean setSuccess()
ChannelFuture
setSuccess
in interface 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.public boolean cancel()
ChannelFuture
cancel
in interface ChannelFuture
true
if and only if the operation has been canceled.
false
if the operation can't be canceled or is already
completed.public boolean isCancelled()
ChannelFuture
true
if and only if this future was
cancelled by a ChannelFuture.cancel()
method.isCancelled
in interface ChannelFuture
Copyright © 2008-2014 The Netty Project. All Rights Reserved.