Package io.netty.channel
Class FailedChannelFuture
java.lang.Object
io.netty.util.concurrent.AbstractFuture<Void>
io.netty.util.concurrent.CompleteFuture<Void>
io.netty.channel.CompleteChannelFuture
io.netty.channel.FailedChannelFuture
- All Implemented Interfaces:
ChannelFuture
,Future<Void>
,Future<Void>
The
CompleteChannelFuture
which is failed already. It is
recommended to use ChannelOutboundInvoker.newFailedFuture(Throwable)
instead of calling the constructor of this future.-
Nested Class Summary
Nested classes/interfaces inherited from interface java.util.concurrent.Future
Future.State
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionFailedChannelFuture
(Channel channel, EventExecutor executor, Throwable cause) Creates a new instance. -
Method Summary
Modifier and TypeMethodDescriptioncause()
Returns the cause of the failed I/O operation if the I/O operation has failed.boolean
Returnstrue
if and only if the I/O operation was completed successfully.sync()
Waits for this future until it is done, and rethrows the cause of the failure if this future failed.Waits for this future until it is done, and rethrows the cause of the failure if this future failed.Methods inherited from class io.netty.channel.CompleteChannelFuture
addListener, addListeners, await, awaitUninterruptibly, channel, executor, getNow, isVoid, removeListener, removeListeners
Methods inherited from class io.netty.util.concurrent.CompleteFuture
await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, isCancellable, isCancelled, isDone
Methods inherited from class io.netty.util.concurrent.AbstractFuture
get, get
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface io.netty.util.concurrent.Future
await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, isCancellable
Methods inherited from interface java.util.concurrent.Future
exceptionNow, get, get, isCancelled, isDone, resultNow, state
-
Field Details
-
cause
-
-
Constructor Details
-
FailedChannelFuture
FailedChannelFuture(Channel channel, EventExecutor executor, Throwable cause) Creates a new instance.- Parameters:
channel
- theChannel
associated with this futurecause
- the cause of failure
-
-
Method Details
-
cause
Description copied from interface:Future
Returns the cause of the failed I/O operation if the I/O operation has failed.- Returns:
- the cause of the failure.
null
if succeeded or this future is not completed yet.
-
isSuccess
public boolean isSuccess()Description copied from interface:Future
Returnstrue
if and only if the I/O operation was completed successfully. -
sync
Description copied from interface:Future
Waits for this future until it is done, and rethrows the cause of the failure if this future failed.- Specified by:
sync
in interfaceChannelFuture
- Specified by:
sync
in interfaceFuture<Void>
- Overrides:
sync
in classCompleteChannelFuture
-
syncUninterruptibly
Description copied from interface:Future
Waits for this future until it is done, and rethrows the cause of the failure if this future failed.- Specified by:
syncUninterruptibly
in interfaceChannelFuture
- Specified by:
syncUninterruptibly
in interfaceFuture<Void>
- Overrides:
syncUninterruptibly
in classCompleteChannelFuture
-