SucceededChannelFuture (Netty API Reference (3.9.9.Final))

java.lang.Object
- org.jboss.netty.channel.CompleteChannelFuture
- - org.jboss.netty.channel.SucceededChannelFuture

All Implemented Interfaces:

ChannelFuture
```
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.

Constructor Summary

Constructors
Constructor and Description

SucceededChannelFuture(Channel channel)
Creates a new instance.

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

Method Summary

Methods
Modifier and Type	Method and Description
`Throwable`	`getCause()` 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`	`rethrowIfFailed()` Deprecated.
`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 org.jboss.netty.channel.CompleteChannelFuture
addListener, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, cancel, getChannel, 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
  - getCause
```
public Throwable getCause()
```
    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.
  - rethrowIfFailed
```
@Deprecated
public ChannelFuture rethrowIfFailed()
                              throws Exception
```
    Deprecated.
    
    Throws:
    
    Exception
  - 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.

Class SucceededChannelFuture

Constructor Summary

Method Summary

Methods inherited from class org.jboss.netty.channel.CompleteChannelFuture

Methods inherited from class java.lang.Object

Constructor Detail

SucceededChannelFuture

Method Detail

getCause

isSuccess

rethrowIfFailed

sync

syncUninterruptibly