io.netty.channel

Class SucceededChannelFuture

java.lang.Object

io.netty.channel.CompleteChannelFuture

io.netty.channel.SucceededChannelFuture

All Implemented Interfaces:

ChannelFuture, Future<Void>

public class SucceededChannelFuture
extends CompleteChannelFuture

The CompleteChannelFuture which is succeeded already. It is recommended to use Channels#succeededFuture(Channel) instead of calling the constructor of this future.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelFuture

ChannelFuture.Unsafe

Constructor Summary

Constructors

Constructor and Description
SucceededChannelFuture(Channel channel) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
Throwable	cause() Returns the cause of the failed I/O operation if the I/O operation has failed.
Void	get()
Void	get(long timeout, TimeUnit unit)
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 io.netty.channel.CompleteChannelFuture

addListener, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, cancel, cancel, channel, isCancelled, isDone, removeListener, setFailure, setProgress, setSuccess

Methods inherited from class java.lang.Object

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

Constructor Detail

SucceededChannelFuture

public SucceededChannelFuture(Channel channel)

Creates a new instance.

Parameters:

channel - the Channel associated with this future

Method Detail

cause

public Throwable cause()

Description copied from interface: ChannelFuture

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: ChannelFuture

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

sync

public ChannelFuture sync()
                   throws InterruptedException

Description copied from interface: ChannelFuture

Waits for this future until it is done, and rethrows the cause of the failure if this future failed. If the cause of the failure is a checked exception, it is wrapped with a new ChannelException before being thrown.

Throws:

InterruptedException

syncUninterruptibly

public ChannelFuture syncUninterruptibly()

Description copied from interface: ChannelFuture

Waits for this future until it is done, and rethrows the cause of the failure if this future failed. If the cause of the failure is a checked exception, it is wrapped with a new ChannelException before being thrown.

get

public Void get()
         throws InterruptedException,
                ExecutionException

Throws:

InterruptedException

ExecutionException

get

public Void get(long timeout,
       TimeUnit unit)
         throws InterruptedException,
                ExecutionException,
                TimeoutException

Throws:

InterruptedException

ExecutionException

TimeoutException