org.jboss.netty.channel
Class FailedChannelFuture

java.lang.Object
  org.jboss.netty.channel.CompleteChannelFuture
      org.jboss.netty.channel.FailedChannelFuture

All Implemented Interfaces:

ChannelFuture

public class FailedChannelFuture
extends CompleteChannelFuture

The CompleteChannelFuture which is failed already. It is recommended to use Channels.failedFuture(Channel, Throwable) instead of calling the constructor of this future.

Version:

$Rev: 50 $, $Date: 2008-08-11 16:33:19 +0900 (Mon, 11 Aug 2008) $

Author:

The Netty Project (netty-dev@lists.jboss.org), Trustin Lee (tlee@redhat.com)

Constructor Summary

FailedChannelFuture(Channel channel, Throwable cause)
Creates a new instance.

Method Summary

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.

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

addListener, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, cancel, getChannel, isCancelled, isDone, removeListener, setFailure, setSuccess

Methods inherited from class java.lang.Object

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

Constructor Detail

FailedChannelFuture

public FailedChannelFuture(Channel channel,
                           Throwable cause)

Creates a new instance.

Parameters:

channel - the Channel associated with this future

cause - the cause of failure

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.