Top Description Fields Constructors Methods
io.netty.channel

pack-priv final Class FailedChannelFuture

extends CompleteChannelFuture
Class Inheritance
Imports
io.netty.util.concurrent.EventExecutor, io.netty.util.internal.ObjectUtil, .PlatformDependent
The CompleteChannelFuture which is failed already. It is recommended to use Channel#newFailedFuture(Throwable) instead of calling the constructor of this future.

Field Summary

Modifier and TypeField and Description
private final Throwable
cause

Constructor Summary

AccessConstructor and Description
pack-priv
FailedChannelFuture(Channel
the Channel associated with this future
channel, EventExecutor executor, Throwable
the cause of failure
cause)

Creates a new instance.

Method Summary

Modifier and TypeMethod and Description
public Throwable
cause()

Implements io.netty.util.concurrent.Future.cause.

Returns the cause of the failed I/O operation if the I/O operation has failed.
public boolean
isSuccess()

Implements io.netty.util.concurrent.Future.isSuccess.

Returns true if and only if the I/O operation was completed successfully.
public ChannelFuture
sync()

Overrides io.netty.channel.CompleteChannelFuture.sync.

Implements io.netty.channel.ChannelFuture.sync, io.netty.util.concurrent.Future.sync.

Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
public ChannelFuture
syncUninterruptibly()

Overrides io.netty.channel.CompleteChannelFuture.syncUninterruptibly.

Implements io.netty.channel.ChannelFuture.syncUninterruptibly, io.netty.util.concurrent.Future.syncUninterruptibly.

Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
Inherited from io.netty.channel.CompleteChannelFuture:
addListeneraddListenersawaitawaitUninterruptiblychannelexecutorgetNowisVoidremoveListenerremoveListeners

Field Detail

causeback to summary
private final Throwable cause

Constructor Detail

FailedChannelFutureback to summary
pack-priv FailedChannelFuture(Channel channel, EventExecutor executor, Throwable cause)

Creates a new instance.

Parameters
channel:Channel

the Channel associated with this future

cause:Throwable

the cause of failure

Method Detail

causeback to summary
public Throwable cause()

Implements io.netty.util.concurrent.Future.cause.

Doc from io.netty.util.concurrent.Future.cause.

Returns the cause of the failed I/O operation if the I/O operation has failed.

Returns:Throwable

the cause of the failure. null if succeeded or this future is not completed yet.

Annotations
@Override
isSuccessback to summary
public boolean isSuccess()

Implements io.netty.util.concurrent.Future.isSuccess.

Doc from io.netty.util.concurrent.Future.isSuccess.

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

Annotations
@Override
syncback to summary
public ChannelFuture sync()

Overrides io.netty.channel.CompleteChannelFuture.sync.

Implements io.netty.channel.ChannelFuture.sync, io.netty.util.concurrent.Future.sync.

Doc from io.netty.util.concurrent.Future.sync.

Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

Annotations
@Override
syncUninterruptiblyback to summary
public ChannelFuture syncUninterruptibly()

Overrides io.netty.channel.CompleteChannelFuture.syncUninterruptibly.

Implements io.netty.channel.ChannelFuture.syncUninterruptibly, io.netty.util.concurrent.Future.syncUninterruptibly.

Doc from io.netty.util.concurrent.Future.syncUninterruptibly.

Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

Annotations
@Override