Package io.netty.channel

Class SucceededChannelFuture

java.lang.Object

io.netty.util.concurrent.AbstractFuture<Void>

io.netty.util.concurrent.CompleteFuture<Void>

io.netty.channel.CompleteChannelFuture

io.netty.channel.SucceededChannelFuture

All Implemented Interfaces:

ChannelFuture, Future<Void>, Future<Void>

final class SucceededChannelFuture
extends CompleteChannelFuture

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

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.concurrent.Future

Future.State

Constructor Summary

Constructors

Constructor	Description
SucceededChannelFuture(Channel channel, EventExecutor executor)	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.

Methods inherited from class io.netty.channel.CompleteChannelFuture

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

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

Constructor Details

SucceededChannelFuture

SucceededChannelFuture(Channel channel,
 EventExecutor executor)

Creates a new instance.

Parameters:

channel - the Channel associated with this future

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.