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>

final class FailedChannelFuture
extends CompleteChannelFuture

The CompleteChannelFuture which is failed already. It is recommended to use ChannelOutboundInvoker.newFailedFuture(Throwable) instead of calling the constructor of this future.

Field Summary

Fields

Modifier and Type	Field	Description
private final Throwable	cause

Constructor Summary

Constructors

Constructor	Description
FailedChannelFuture(Channel channel, EventExecutor executor, Throwable cause)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
Throwable	cause()	Returns the cause of the failed I/O operation if the I/O operation has failed.
boolean	isSuccess()	Returns true if and only if the I/O operation was completed successfully.
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.

Methods inherited from class CompleteChannelFuture

addListener, addListeners, await, awaitUninterruptibly, channel, executor, getNow, isVoid, removeListener, removeListeners

Methods inherited from class CompleteFuture

await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, isCancellable, isCancelled, isDone

Methods inherited from class AbstractFuture

get, get

Methods inherited from class Object

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

Methods inherited from interface Future

await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, isCancellable

Methods inherited from interface Future

get, get, isCancelled, isDone

Field Details

cause

private final Throwable cause

Constructor Details

FailedChannelFuture

FailedChannelFuture(Channel channel,
 EventExecutor executor,
 Throwable cause)

Creates a new instance.

Parameters:

channel - the Channel associated with this future

cause - the cause of failure

Method Details

cause

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

Returns true if and only if the I/O operation was completed successfully.

sync

public ChannelFuture 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 interface ChannelFuture

Specified by:

sync in interface Future<Void>

Overrides:

sync in class CompleteChannelFuture

syncUninterruptibly

public ChannelFuture 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 interface ChannelFuture

Specified by:

syncUninterruptibly in interface Future<Void>

Overrides:

syncUninterruptibly in class CompleteChannelFuture