All Superinterfaces:

ChannelFuture, ChannelProgressiveFuture, ChannelPromise, java.util.concurrent.Future<java.lang.Void>, ProgressiveFuture<java.lang.Void>, ProgressivePromise<java.lang.Void>, Promise<java.lang.Void>

All Known Implementing Classes:

DefaultChannelProgressivePromise

public interface ChannelProgressivePromise
extends ProgressivePromise<java.lang.Void>, ChannelProgressiveFuture, ChannelPromise 

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  ChannelProgressivePromise	addListener (GenericFutureListener<? extends Future<? super java.lang.Void>> listener) Adds the specified listener to this future.
  ChannelProgressivePromise	addListeners (GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners) Adds the specified listeners to this future.
  ChannelProgressivePromise	await () Waits for this future to be completed.
  ChannelProgressivePromise	awaitUninterruptibly () Waits for this future to be completed without interruption.
  ChannelProgressivePromise	removeListener (GenericFutureListener<? extends Future<? super java.lang.Void>> listener) Removes the first occurrence of the specified listener from this future.
  ChannelProgressivePromise	removeListeners (GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners) Removes the first occurrence for each of the listeners from this future.
  ChannelProgressivePromise	setFailure (java.lang.Throwable cause) Marks this future as a failure and notifies all listeners.
  ChannelProgressivePromise	setProgress (long progress, long total) Sets the current progress of the operation and notifies the listeners that implement GenericProgressiveFutureListener.
  ChannelProgressivePromise	setSuccess ()
  ChannelProgressivePromise	setSuccess (java.lang.Void result) Marks this future as a success and notifies all listeners.
  ChannelProgressivePromise	sync () Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
  ChannelProgressivePromise	syncUninterruptibly () Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

  • Methods inherited from interface io.netty.util.concurrent.ProgressivePromise

    tryProgress

  • Methods inherited from interface io.netty.channel.ChannelPromise

    channel, trySuccess

  • Methods inherited from interface io.netty.util.concurrent.Promise

    setUncancellable, tryFailure, trySuccess

  • Methods inherited from interface io.netty.util.concurrent.Future

    await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, cause, getNow, isCancellable, isSuccess

  • Methods inherited from interface java.util.concurrent.Future

    get, get, isCancelled, isDone

• Method Detail

  • addListener

    ChannelProgressivePromise addListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener)

    Description copied from interface: Future
    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

    Specified by:

    addListener in interface ChannelProgressiveFuture

    Specified by:

    addListener in interface ChannelPromise

    Specified by:

    addListener in interface ProgressiveFuture<java.lang.Void>

    Specified by:

    addListener in interface ProgressivePromise<java.lang.Void>

    Specified by:

    addListener in interface Promise<java.lang.Void>

  • addListeners

    ChannelProgressivePromise addListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners)

    Description copied from interface: Future
    Adds the specified listeners to this future. The specified listeners are notified when this future is done. If this future is already completed, the specified listeners are notified immediately.

    Specified by:

    addListeners in interface ChannelFuture

    Specified by:

    addListeners in interface ChannelProgressiveFuture

    Specified by:

    addListeners in interface ChannelPromise

    Specified by:

    addListeners in interface ProgressiveFuture<java.lang.Void>

    Specified by:

    addListeners in interface ProgressivePromise<java.lang.Void>

    Specified by:

    addListeners in interface Promise<java.lang.Void>

  • removeListener

    ChannelProgressivePromise removeListener(GenericFutureListener<? extends Future<? super java.lang.Void>> listener)

    Description copied from interface: Future
    Removes the first occurrence of 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

    Specified by:

    removeListener in interface ChannelProgressiveFuture

    Specified by:

    removeListener in interface ChannelPromise

    Specified by:

    removeListener in interface ProgressiveFuture<java.lang.Void>

    Specified by:

    removeListener in interface ProgressivePromise<java.lang.Void>

    Specified by:

    removeListener in interface Promise<java.lang.Void>

  • removeListeners

    ChannelProgressivePromise removeListeners(GenericFutureListener<? extends Future<? super java.lang.Void>>... listeners)

    Description copied from interface: Future
    Removes the first occurrence for each of the listeners from this future. The specified listeners are no longer notified when this future is done. If the specified listeners are not associated with this future, this method does nothing and returns silently.

    Specified by:

    removeListeners in interface ChannelFuture

    Specified by:

    removeListeners in interface ChannelProgressiveFuture

    Specified by:

    removeListeners in interface ChannelPromise

    Specified by:

    removeListeners in interface ProgressiveFuture<java.lang.Void>

    Specified by:

    removeListeners in interface ProgressivePromise<java.lang.Void>

    Specified by:

    removeListeners in interface Promise<java.lang.Void>

  • sync

    ChannelProgressivePromise sync()
     throws java.lang.InterruptedException

    Description copied from interface: Future
    Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

    Specified by:

    sync in interface ChannelFuture

    Specified by:

    sync in interface ChannelProgressiveFuture

    Specified by:

    sync in interface ChannelPromise

    Specified by:

    sync in interface ProgressiveFuture<java.lang.Void>

    Specified by:

    sync in interface ProgressivePromise<java.lang.Void>

    Specified by:

    sync in interface Promise<java.lang.Void>

    Throws:

    java.lang.InterruptedException

  • syncUninterruptibly

    ChannelProgressivePromise syncUninterruptibly()

    Description copied from interface: Future
    Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

    Specified by:

    syncUninterruptibly in interface ChannelFuture

    Specified by:

    syncUninterruptibly in interface ChannelProgressiveFuture

    Specified by:

    syncUninterruptibly in interface ChannelPromise

    Specified by:

    syncUninterruptibly in interface ProgressiveFuture<java.lang.Void>

    Specified by:

    syncUninterruptibly in interface ProgressivePromise<java.lang.Void>

    Specified by:

    syncUninterruptibly in interface Promise<java.lang.Void>

  • await

    ChannelProgressivePromise await()
     throws java.lang.InterruptedException

    Description copied from interface: Future
    Waits for this future to be completed.

    Specified by:

    await in interface ChannelFuture

    Specified by:

    await in interface ChannelProgressiveFuture

    Specified by:

    await in interface ChannelPromise

    Specified by:

    await in interface ProgressiveFuture<java.lang.Void>

    Specified by:

    await in interface ProgressivePromise<java.lang.Void>

    Specified by:

    await in interface Promise<java.lang.Void>

    Throws:

    java.lang.InterruptedException - if the current thread was interrupted

  • awaitUninterruptibly

    ChannelProgressivePromise awaitUninterruptibly()

    Description copied from interface: Future
    Waits for this future to be completed without interruption. This method catches an InterruptedException and discards it silently.

    Specified by:

    awaitUninterruptibly in interface ChannelFuture

    Specified by:

    awaitUninterruptibly in interface ChannelProgressiveFuture

    Specified by:

    awaitUninterruptibly in interface ChannelPromise

    Specified by:

    awaitUninterruptibly in interface ProgressiveFuture<java.lang.Void>

    Specified by:

    awaitUninterruptibly in interface ProgressivePromise<java.lang.Void>

    Specified by:

    awaitUninterruptibly in interface Promise<java.lang.Void>

  • setSuccess

    ChannelProgressivePromise setSuccess(java.lang.Void result)

    Description copied from interface: Promise
    Marks this future as a success and notifies all listeners. If it is success or failed already it will throw an IllegalStateException.

    Specified by:

    setSuccess in interface ChannelPromise

    Specified by:

    setSuccess in interface ProgressivePromise<java.lang.Void>

    Specified by:

    setSuccess in interface Promise<java.lang.Void>

  • setSuccess

    ChannelProgressivePromise setSuccess()

    Specified by:

    setSuccess in interface ChannelPromise

  • setFailure

    ChannelProgressivePromise setFailure(java.lang.Throwable cause)

    Description copied from interface: Promise
    Marks this future as a failure and notifies all listeners. If it is success or failed already it will throw an IllegalStateException.

    Specified by:

    setFailure in interface ChannelPromise

    Specified by:

    setFailure in interface ProgressivePromise<java.lang.Void>

    Specified by:

    setFailure in interface Promise<java.lang.Void>

  • setProgress

    ChannelProgressivePromise setProgress(long progress,
     long total)

    Description copied from interface: ProgressivePromise
    Sets the current progress of the operation and notifies the listeners that implement GenericProgressiveFutureListener.

    Specified by:

    setProgress in interface ProgressivePromise<java.lang.Void>