play.libs.concurrent

Interface Timeout

public interface Timeout

This interface is used to provide a non-blocking timeout on an operation that returns a CompletionStage. To use a non-blocking timeout, have a class implement the Timeout trait:

 class MyClass implements play.libs.concurrent.Timeout {
     CompletionStage<Double> callWithTimeout() {
         return timeout(longRunningOperation(), Duration.ofSeconds(1));
     }
 } 
 

Method Summary

Modifier and Type	Method and Description
default <A> java.util.concurrent.CompletionStage<A>	timeout(java.util.concurrent.CompletionStage<A> stage, java.time.Duration delay) An alias for timeout(stage, delay, unit) that uses a java.time.Duration.
default <A> java.util.concurrent.CompletionStage<A>	timeout(java.util.concurrent.CompletionStage<A> stage, long delay, java.util.concurrent.TimeUnit unit) Creates a CompletionStage that returns either the input stage, or a timeout.

Method Detail

timeout

default <A> java.util.concurrent.CompletionStage<A> timeout(java.util.concurrent.CompletionStage<A> stage,
                                                            long delay,
                                                            java.util.concurrent.TimeUnit unit)

Creates a CompletionStage that returns either the input stage, or a timeout. Note that timeout is not the same as cancellation. Even in case of timeout, the given completion stage will still complete, even though that completed value is not returned.

Type Parameters:

A - the completion's result type.

Parameters:

stage - the input completion stage that may time out.

delay - The delay (expressed with the corresponding unit).

unit - The time Unit.

Returns:

either the completed future, or a completion stage that failed with timeout.

timeout

default <A> java.util.concurrent.CompletionStage<A> timeout(java.util.concurrent.CompletionStage<A> stage,
                                                            java.time.Duration delay)

An alias for timeout(stage, delay, unit) that uses a java.time.Duration.

Type Parameters:

A - the completion stage that should be wrapped with a future.

Parameters:

stage - the input completion stage that may time out.

delay - The delay (expressed with the corresponding unit).

Returns:

the completion stage, or a completion stage that failed with timeout.