Module io.netty5.common
Package io.netty5.util.concurrent

Interface RunnableScheduledFuture<V>

    • Method Detail

      • isPeriodic

        boolean isPeriodic()
        Return true if the task is periodic, which means it may be executed multiple times, as opposed to a delayed task or a normal task, that only execute once.
        Returns:
        true if this task is periodic, otherwise false.

      • deadlineNanos

        long deadlineNanos()
        Returns the deadline in nanos when the Runnable.run() method should be called again.

      • delayNanos

        long delayNanos()
        Returns the delay in nanos when the Runnable.run() method should be called again.

      • delayNanos

        long delayNanos​(long currentTimeNanos)
        Returns the delay in nanos (taking the given currentTimeNanos into account) when the Runnable.run() method should be called again.

      • addListener

        RunnableScheduledFuture<V> addListener​(FutureListener<? super V> 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 Future<V>
        Specified by:
        addListener in interface RunnableFuture<V>
        Parameters:
        listener - The listener to be called when this future completes. The listener will be passed this future as an argument.
        Returns:
        this future object.

      • addListener

        <C> RunnableScheduledFuture<V> addListener​(C context,
                                           FutureContextListener<? super C,​? super V> 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 Future<V>
        Specified by:
        addListener in interface RunnableFuture<V>
        Parameters:
        context - The context object that will be passed to the listener when this future completes.
        listener - The listener to be called when this future completes. The listener will be passed the given context, and this future.
        Returns:
        this future object.

      • cancel

        boolean cancel()
        Cancel this asynchronous operation, unless it has already been completed or is not cancellable.

        A cancelled operation is considered to be done and failed.

        If the cancellation was successful, the result of this operation will be that it has failed with a CancellationException.

        Cancellation will not cause any threads working on the operation to be interrupted.

        Returns:
        true if the operation was cancelled by this call, otherwise false.

      • isSuccess

        boolean isSuccess()
        Returns true if and only if the operation was completed successfully.

      • isFailed

        boolean isFailed()
        Returns true if and only if the operation was completed and failed.

      • isCancelled

        boolean isCancelled()
        Return true if this operation has been cancelled.
        Returns:
        true if this operation has been cancelled, otherwise false.

      • isDone

        boolean isDone()
        Return true if this operation has been completed either successfully, unsuccessfully, or through cancellation.
        Returns:
        true if this operation has completed, otherwise false.

      • isCancellable

        boolean isCancellable()
        Returns true if and only if the operation can be cancelled via cancel(). Note that this is inherently racy, as the operation could be made uncancellable at any time.
        Returns:
        true if this operation can be cancelled.

      • getNow

        V getNow()
        Return the successful result of this asynchronous operation, if any. If the operation has not yet been completed, then this will throw IllegalStateException. If the operation has been cancelled or failed with an exception, then this returns null. Note that asynchronous operations can also be completed successfully with a null result.
        Returns:
        the result of this operation, if completed successfully.
        Throws:
        IllegalStateException - if this Future or Promise has not completed yet.

      • cause

        Throwable cause()
        Returns the cause of the failed operation if the operation has failed.
        Returns:
        The cause of the failure, if any. Otherwise null if succeeded.
        Throws:
        IllegalStateException - if this Promise has not completed yet.