Class CompleteChannelFuture

java.lang.Object
org.jboss.netty.channel.CompleteChannelFuture
All Implemented Interfaces:
ChannelFuture
Direct Known Subclasses:
FailedChannelFuture, SucceededChannelFuture
public abstract class CompleteChannelFuture extends Object implements ChannelFuture
A skeletal ChannelFuture implementation which represents a ChannelFuture which has been completed already.

  • Field Details

  • Constructor Details

    • CompleteChannelFuture

      protected CompleteChannelFuture(Channel channel)
      Creates a new instance.
      Parameters:
      channel - the Channel associated with this future

  • Method Details

    • addListener

      public void addListener(ChannelFutureListener listener)
      Description copied from interface: ChannelFuture
      Adds the specified listener to this future. The specified listener is notified when this future is done. If this future is already completed, the specified listener is notified immediately.
      Specified by:
      addListener in interface ChannelFuture

    • removeListener

      public void removeListener(ChannelFutureListener listener)
      Description copied from interface: ChannelFuture
      Removes the specified listener from this future. The specified listener is no longer notified when this future is done. If the specified listener is not associated with this future, this method does nothing and returns silently.
      Specified by:
      removeListener in interface ChannelFuture

    • await

      public ChannelFuture await() throws InterruptedException
      Description copied from interface: ChannelFuture
      Waits for this future to be completed.
      Specified by:
      await in interface ChannelFuture
      Throws:
      InterruptedException - if the current thread was interrupted

    • await

      public boolean await(long timeout, TimeUnit unit) throws InterruptedException
      Description copied from interface: ChannelFuture
      Waits for this future to be completed within the specified time limit.
      Specified by:
      await in interface ChannelFuture
      Returns:
      true if and only if the future was completed within the specified time limit
      Throws:
      InterruptedException - if the current thread was interrupted

    • await

      public boolean await(long timeoutMillis) throws InterruptedException
      Description copied from interface: ChannelFuture
      Waits for this future to be completed within the specified time limit.
      Specified by:
      await in interface ChannelFuture
      Returns:
      true if and only if the future was completed within the specified time limit
      Throws:
      InterruptedException - if the current thread was interrupted

    • awaitUninterruptibly

      public ChannelFuture awaitUninterruptibly()
      Description copied from interface: ChannelFuture
      Waits for this future to be completed without interruption. This method catches an InterruptedException and discards it silently.
      Specified by:
      awaitUninterruptibly in interface ChannelFuture

    • awaitUninterruptibly

      public boolean awaitUninterruptibly(long timeout, TimeUnit unit)
      Description copied from interface: ChannelFuture
      Waits for this future to be completed within the specified time limit without interruption. This method catches an InterruptedException and discards it silently.
      Specified by:
      awaitUninterruptibly in interface ChannelFuture
      Returns:
      true if and only if the future was completed within the specified time limit

    • awaitUninterruptibly

      public boolean awaitUninterruptibly(long timeoutMillis)
      Description copied from interface: ChannelFuture
      Waits for this future to be completed within the specified time limit without interruption. This method catches an InterruptedException and discards it silently.
      Specified by:
      awaitUninterruptibly in interface ChannelFuture
      Returns:
      true if and only if the future was completed within the specified time limit

    • getChannel

      public Channel getChannel()
      Description copied from interface: ChannelFuture
      Returns a channel where the I/O operation associated with this future takes place.
      Specified by:
      getChannel in interface ChannelFuture

    • isDone

      public boolean isDone()
      Description copied from interface: ChannelFuture
      Returns true if and only if this future is complete, regardless of whether the operation was successful, failed, or cancelled.
      Specified by:
      isDone in interface ChannelFuture

    • setProgress

      public boolean setProgress(long amount, long current, long total)
      Description copied from interface: ChannelFuture
      Notifies the progress of the operation to the listeners that implements ChannelFutureProgressListener. Please note that this method will not do anything and return false if this future is complete already.
      Specified by:
      setProgress in interface ChannelFuture
      Returns:
      true if and only if notification was made.

    • setFailure

      public boolean setFailure(Throwable cause)
      Description copied from interface: ChannelFuture
      Marks this future as a failure and notifies all listeners.
      Specified by:
      setFailure in interface ChannelFuture
      Returns:
      true if and only if successfully marked this future as a failure. Otherwise false because this future is already marked as either a success or a failure.

    • setSuccess

      public boolean setSuccess()
      Description copied from interface: ChannelFuture
      Marks this future as a success and notifies all listeners.
      Specified by:
      setSuccess in interface ChannelFuture
      Returns:
      true if and only if successfully marked this future as a success. Otherwise false because this future is already marked as either a success or a failure.

    • cancel

      public boolean cancel()
      Description copied from interface: ChannelFuture
      Cancels the I/O operation associated with this future and notifies all listeners if canceled successfully.
      Specified by:
      cancel in interface ChannelFuture
      Returns:
      true if and only if the operation has been canceled. false if the operation can't be canceled or is already completed.

    • isCancelled

      public boolean isCancelled()
      Description copied from interface: ChannelFuture
      Returns true if and only if this future was cancelled by a ChannelFuture.cancel() method.
      Specified by:
      isCancelled in interface ChannelFuture