public class DefaultChannelFuture extends Object implements ChannelFuture
ChannelFuture
implementation. It is recommended to
use Channels.future(Channel)
and Channels.future(Channel, boolean)
to create a new ChannelFuture
rather than calling the constructor
explicitly.Constructor and Description |
---|
DefaultChannelFuture(Channel channel,
boolean cancellable)
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.
|
Throwable |
getCause()
Returns the cause of the failed I/O operation if the I/O operation has
failed.
|
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. |
boolean |
isSuccess()
Returns
true if and only if the I/O operation was completed
successfully. |
static boolean |
isUseDeadLockChecker()
Returns
true if and only if the dead lock checker is enabled. |
void |
removeListener(ChannelFutureListener listener)
Removes the specified listener from this future.
|
ChannelFuture |
rethrowIfFailed()
Deprecated.
|
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.
|
static void |
setUseDeadLockChecker(boolean useDeadLockChecker)
Enables or disables the dead lock checker.
|
ChannelFuture |
sync()
Waits for this future until it is done, and rethrows the cause of the failure if this future
failed.
|
ChannelFuture |
syncUninterruptibly()
Waits for this future until it is done, and rethrows the cause of the failure if this future
failed.
|
public static boolean isUseDeadLockChecker()
true
if and only if the dead lock checker is enabled.public static void setUseDeadLockChecker(boolean useDeadLockChecker)
public 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 isSuccess()
ChannelFuture
true
if and only if the I/O operation was completed
successfully.isSuccess
in interface ChannelFuture
public Throwable getCause()
ChannelFuture
getCause
in interface ChannelFuture
null
if succeeded or this future is not
completed yet.public boolean isCancelled()
ChannelFuture
true
if and only if this future was
cancelled by a ChannelFuture.cancel()
method.isCancelled
in interface ChannelFuture
public void addListener(ChannelFutureListener listener)
ChannelFuture
addListener
in interface ChannelFuture
public void removeListener(ChannelFutureListener listener)
ChannelFuture
removeListener
in interface ChannelFuture
@Deprecated public ChannelFuture rethrowIfFailed() throws Exception
rethrowIfFailed
in interface ChannelFuture
Exception
public ChannelFuture sync() throws InterruptedException
ChannelFuture
ChannelException
before being thrown.sync
in interface ChannelFuture
InterruptedException
public ChannelFuture syncUninterruptibly()
ChannelFuture
ChannelException
before being thrown.syncUninterruptibly
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 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 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 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 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.Copyright © 2008-2014 The Netty Project. All Rights Reserved.