Class SucceededChannelFuture

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 Details

    • SucceededChannelFuture

      public SucceededChannelFuture(Channel channel)
      Creates a new instance.
      Parameters:
      channel - the Channel associated with this future
  • Method Details

    • 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.
    • 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.