Class Patterns
- java.lang.Object
-
- org.apache.pekko.pattern.Patterns
-
public class Patterns extends java.lang.Object
Java API: for Pekko patterns such asask
,pipe
and others which work withCompletionStage
.
-
-
Constructor Summary
Constructors Constructor Description Patterns()
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static <T> java.util.concurrent.CompletionStage<T>
after(java.time.Duration duration, ClassicActorSystemProvider system, java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> value)
Returns aCompletionStage
that will be completed with the success or failure of the provided Callable after the specified duration.static <T> java.util.concurrent.CompletionStage<T>
after(java.time.Duration duration, Scheduler scheduler, scala.concurrent.ExecutionContext context, java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> value)
Returns aCompletionStage
that will be completed with the success or failure of the provided Callable after the specified duration.static <T> java.util.concurrent.CompletionStage<T>
after(java.time.Duration duration, Scheduler scheduler, scala.concurrent.ExecutionContext context, java.util.concurrent.CompletionStage<T> value)
Deprecated.Use the overloaded one which accepts a Callable of CompletionStage instead.static <T> scala.concurrent.Future<T>
after(scala.concurrent.duration.FiniteDuration duration, Scheduler scheduler, scala.concurrent.ExecutionContext context, java.util.concurrent.Callable<scala.concurrent.Future<T>> value)
Returns aFuture
that will be completed with the success or failure of the provided Callable after the specified duration.static <T> scala.concurrent.Future<T>
after(scala.concurrent.duration.FiniteDuration duration, Scheduler scheduler, scala.concurrent.ExecutionContext context, scala.concurrent.Future<T> value)
Deprecated.Use the overload one which accepts a Callable of Future instead.static scala.concurrent.Future<java.lang.Object>
ask(ActorRef actor, java.lang.Object message, long timeoutMillis)
Java API fororg.apache.pekko.pattern.ask
: Sends a message asynchronously and returns aFuture
holding the eventual reply message; this means that the target actor needs to send the result to thesender
reference provided.static java.util.concurrent.CompletionStage<java.lang.Object>
ask(ActorRef actor, java.lang.Object message, java.time.Duration timeout)
Java API fororg.apache.pekko.pattern.ask
: Sends a message asynchronously and returns aCompletionStage
holding the eventual reply message; this means that the target actor needs to send the result to thesender
reference provided.static scala.concurrent.Future<java.lang.Object>
ask(ActorRef actor, java.lang.Object message, Timeout timeout)
Java API fororg.apache.pekko.pattern.ask
: Sends a message asynchronously and returns aFuture
holding the eventual reply message; this means that the target actor needs to send the result to thesender
reference provided.static scala.concurrent.Future<java.lang.Object>
ask(ActorSelection selection, java.lang.Object message, long timeoutMillis)
Java API fororg.apache.pekko.pattern.ask
: Sends a message asynchronously and returns aFuture
holding the eventual reply message; this means that the targetpekko.actor.ActorSelection
needs to send the result to thesender
reference provided.static java.util.concurrent.CompletionStage<java.lang.Object>
ask(ActorSelection selection, java.lang.Object message, java.time.Duration timeout)
Java API fororg.apache.pekko.pattern.ask
: Sends a message asynchronously and returns aCompletionStage
holding the eventual reply message; this means that the targetpekko.actor.ActorSelection
needs to send the result to thesender
reference provided.static scala.concurrent.Future<java.lang.Object>
ask(ActorSelection selection, java.lang.Object message, Timeout timeout)
Java API fororg.apache.pekko.pattern.ask
: Sends a message asynchronously and returns aFuture
holding the eventual reply message; this means that the targetpekko.actor.ActorSelection
needs to send the result to thesender
reference provided.static java.util.concurrent.CompletionStage<java.lang.Object>
askWithReplyTo(ActorRef actor, Function<ActorRef,java.lang.Object> messageFactory, java.time.Duration timeout)
A variation of ask which allows to implement "replyTo" pattern by including sender reference in message.static scala.concurrent.Future<java.lang.Object>
askWithReplyTo(ActorRef actor, Function<ActorRef,java.lang.Object> messageFactory, long timeoutMillis)
A variation of ask which allows to implement "replyTo" pattern by including sender reference in message.static scala.concurrent.Future<java.lang.Object>
askWithReplyTo(ActorRef actor, Function<ActorRef,java.lang.Object> messageFactory, Timeout timeout)
A variation of ask which allows to implement "replyTo" pattern by including sender reference in message.static scala.concurrent.Future<java.lang.Object>
askWithReplyTo(ActorSelection selection, Function<ActorRef,java.lang.Object> messageFactory, long timeoutMillis)
A variation of ask which allows to implement "replyTo" pattern by including sender reference in message.static java.util.concurrent.CompletionStage<java.lang.Object>
askWithReplyTo(ActorSelection selection, Function<ActorRef,java.lang.Object> messageFactory, java.time.Duration timeout)
A variation of ask which allows to implement "replyTo" pattern by including sender reference in message.static java.util.concurrent.CompletionStage<java.lang.Object>
askWithStatus(ActorRef actor, java.lang.Object message, java.time.Duration timeout)
Use for messages whose response is known to be apekko.pattern.StatusReply
.static java.util.concurrent.CompletionStage<java.lang.Boolean>
gracefulStop(ActorRef target, java.time.Duration timeout)
Returns aCompletionStage
that will be completed with success (valuetrue
) when existing messages of the target actor has been processed and the actor has been terminated.static java.util.concurrent.CompletionStage<java.lang.Boolean>
gracefulStop(ActorRef target, java.time.Duration timeout, java.lang.Object stopMessage)
Returns aCompletionStage
that will be completed with success (valuetrue
) when existing messages of the target actor has been processed and the actor has been terminated.static scala.concurrent.Future<java.lang.Boolean>
gracefulStop(ActorRef target, scala.concurrent.duration.FiniteDuration timeout)
Returns aFuture
that will be completed with success (valuetrue
) when existing messages of the target actor has been processed and the actor has been terminated.static scala.concurrent.Future<java.lang.Boolean>
gracefulStop(ActorRef target, scala.concurrent.duration.FiniteDuration timeout, java.lang.Object stopMessage)
Returns aFuture
that will be completed with success (valuetrue
) when existing messages of the target actor has been processed and the actor has been terminated.static <T> PipeToSupport.PipeableCompletionStage<T>
pipe(java.util.concurrent.CompletionStage<T> future, scala.concurrent.ExecutionContext context)
When thisCompletionStage
finishes, send its result to the givenpekko.actor.ActorRef
orpekko.actor.ActorSelection
.static <T> PipeToSupport.PipeableFuture<T>
pipe(scala.concurrent.Future<T> future, scala.concurrent.ExecutionContext context)
Register an onComplete callback on thisFuture
to send the result to the givenpekko.actor.ActorRef
orpekko.actor.ActorSelection
.static <T> java.util.concurrent.CompletionStage<T>
retry(java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> attempt, int attempts, java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, ClassicActorSystemProvider system)
Returns an internally retryingCompletionStage
The first attempt will be made immediately, each subsequent attempt will be made with a backoff time, if the previous attempt failed.static <T> java.util.concurrent.CompletionStage<T>
retry(java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> attempt, int attempts, java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, Scheduler scheduler, scala.concurrent.ExecutionContext ec)
Returns an internally retryingCompletionStage
The first attempt will be made immediately, each subsequent attempt will be made with a backoff time, if the previous attempt failed.static <T> java.util.concurrent.CompletionStage<T>
retry(java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> attempt, int attempts, java.time.Duration delay, ClassicActorSystemProvider system)
Returns an internally retryingCompletionStage
The first attempt will be made immediately, and each subsequent attempt will be made after 'delay'.static <T> java.util.concurrent.CompletionStage<T>
retry(java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> attempt, int attempts, java.time.Duration delay, Scheduler scheduler, scala.concurrent.ExecutionContext ec)
Returns an internally retryingCompletionStage
The first attempt will be made immediately, and each subsequent attempt will be made after 'delay'.static <T> java.util.concurrent.CompletionStage<T>
retry(java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> attempt, int attempts, java.util.function.IntFunction<java.util.Optional<java.time.Duration>> delayFunction, Scheduler scheduler, scala.concurrent.ExecutionContext context)
Returns an internally retryingCompletionStage
.static <T> java.util.concurrent.CompletionStage<T>
retry(java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> attempt, int attempts, scala.concurrent.ExecutionContext ec)
Returns an internally retryingCompletionStage
The first attempt will be made immediately, each subsequent attempt will be made immediately if the previous attempt failed.static <T> java.util.concurrent.CompletionStage<T>
retry(java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> attempt, java.util.function.BiPredicate<T,java.lang.Throwable> shouldRetry, int attempts, java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, ClassicActorSystemProvider system)
Returns an internally retryingCompletionStage
.static <T> java.util.concurrent.CompletionStage<T>
retry(java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> attempt, java.util.function.BiPredicate<T,java.lang.Throwable> shouldRetry, int attempts, java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, Scheduler scheduler, scala.concurrent.ExecutionContext ec)
Returns an internally retryingCompletionStage
.static <T> java.util.concurrent.CompletionStage<T>
retry(java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> attempt, java.util.function.BiPredicate<T,java.lang.Throwable> shouldRetry, int attempts, java.time.Duration delay, ClassicActorSystemProvider system)
Returns an internally retryingCompletionStage
.static <T> java.util.concurrent.CompletionStage<T>
retry(java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> attempt, java.util.function.BiPredicate<T,java.lang.Throwable> shouldRetry, int attempts, java.time.Duration delay, Scheduler scheduler, scala.concurrent.ExecutionContext ec)
Returns an internally retryingCompletionStage
.static <T> java.util.concurrent.CompletionStage<T>
retry(java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> attempt, java.util.function.BiPredicate<T,java.lang.Throwable> shouldRetry, int attempts, java.util.function.IntFunction<java.util.Optional<java.time.Duration>> delayFunction, Scheduler scheduler, scala.concurrent.ExecutionContext context)
Returns an internally retryingCompletionStage
.static <T> java.util.concurrent.CompletionStage<T>
retry(java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> attempt, java.util.function.BiPredicate<T,java.lang.Throwable> shouldRetry, int attempts, scala.concurrent.ExecutionContext ec)
Returns an internally retryingCompletionStage
.static <T> scala.concurrent.Future<T>
retry(java.util.concurrent.Callable<scala.concurrent.Future<T>> attempt, int attempts, scala.concurrent.duration.FiniteDuration delay, Scheduler scheduler, scala.concurrent.ExecutionContext context)
Returns an internally retryingFuture
The first attempt will be made immediately, and each subsequent attempt will be made after 'delay'.
-
-
-
Method Detail
-
ask
public static scala.concurrent.Future<java.lang.Object> ask(ActorRef actor, java.lang.Object message, Timeout timeout)
Java API fororg.apache.pekko.pattern.ask
: Sends a message asynchronously and returns aFuture
holding the eventual reply message; this means that the target actor needs to send the result to thesender
reference provided.The Future will be completed with an
pekko.pattern.AskTimeoutException
after the given timeout has expired; this is independent from any timeout applied while awaiting a result for this future (i.e. inAwait.result(..., timeout)
). A typical reason forAskTimeoutException
is that the recipient actor didn't send a reply.Warning: When using future callbacks, inside actors you need to carefully avoid closing over the containing actor’s object, i.e. do not call methods or access mutable state on the enclosing actor from within the callback. This would break the actor encapsulation and may introduce synchronization bugs and race conditions because the callback will be scheduled concurrently to the enclosing actor. Unfortunately there is not yet a way to detect these illegal accesses at compile time.
Recommended usage:
final Future<Object> f = Patterns.ask(worker, request, timeout); f.onSuccess(new Procedure<Object>() { public void apply(Object o) { nextActor.tell(new EnrichedResult(request, o)); } });
-
ask
public static java.util.concurrent.CompletionStage<java.lang.Object> ask(ActorRef actor, java.lang.Object message, java.time.Duration timeout)
Java API fororg.apache.pekko.pattern.ask
: Sends a message asynchronously and returns aCompletionStage
holding the eventual reply message; this means that the target actor needs to send the result to thesender
reference provided.The CompletionStage will be completed with an
pekko.pattern.AskTimeoutException
after the given timeout has expired; this is independent from any timeout applied while awaiting a result for this future (i.e. inAwait.result(..., timeout)
). A typical reason forAskTimeoutException
is that the recipient actor didn't send a reply.Warning: When using future callbacks, inside actors you need to carefully avoid closing over the containing actor’s object, i.e. do not call methods or access mutable state on the enclosing actor from within the callback. This would break the actor encapsulation and may introduce synchronization bugs and race conditions because the callback will be scheduled concurrently to the enclosing actor. Unfortunately there is not yet a way to detect these illegal accesses at compile time.
Recommended usage:
final CompletionStage<Object> f = Patterns.ask(worker, request, duration); f.thenRun(result -> nextActor.tell(new EnrichedResult(request, result)));
-
askWithStatus
public static java.util.concurrent.CompletionStage<java.lang.Object> askWithStatus(ActorRef actor, java.lang.Object message, java.time.Duration timeout)
Use for messages whose response is known to be apekko.pattern.StatusReply
. When apekko.pattern.StatusReply#success
response arrives the future is completed with the wrapped value, if apekko.pattern.StatusReply#error
arrives the future is instead failed.
-
askWithReplyTo
public static scala.concurrent.Future<java.lang.Object> askWithReplyTo(ActorRef actor, Function<ActorRef,java.lang.Object> messageFactory, Timeout timeout)
A variation of ask which allows to implement "replyTo" pattern by including sender reference in message.final Future<Object> f = Patterns.askWithReplyTo( worker, replyTo -> new Request(replyTo), timeout);
-
askWithReplyTo
public static java.util.concurrent.CompletionStage<java.lang.Object> askWithReplyTo(ActorRef actor, Function<ActorRef,java.lang.Object> messageFactory, java.time.Duration timeout)
A variation of ask which allows to implement "replyTo" pattern by including sender reference in message.final CompletionStage<Object> f = Patterns.askWithReplyTo( worker, askSender -> new Request(askSender), timeout);
- Parameters:
actor
- the actor to be askedmessageFactory
- function taking an actor ref and returning the message to be senttimeout
- the timeout for the response before failing the returned completion stage
-
ask
public static scala.concurrent.Future<java.lang.Object> ask(ActorRef actor, java.lang.Object message, long timeoutMillis)
Java API fororg.apache.pekko.pattern.ask
: Sends a message asynchronously and returns aFuture
holding the eventual reply message; this means that the target actor needs to send the result to thesender
reference provided.The Future will be completed with an
pekko.pattern.AskTimeoutException
after the given timeout has expired; this is independent from any timeout applied while awaiting a result for this future (i.e. inAwait.result(..., timeout)
). A typical reason forAskTimeoutException
is that the recipient actor didn't send a reply.Warning: When using future callbacks, inside actors you need to carefully avoid closing over the containing actor’s object, i.e. do not call methods or access mutable state on the enclosing actor from within the callback. This would break the actor encapsulation and may introduce synchronization bugs and race conditions because the callback will be scheduled concurrently to the enclosing actor. Unfortunately there is not yet a way to detect these illegal accesses at compile time.
Recommended usage:
final Future<Object> f = Patterns.ask(worker, request, timeout); f.onSuccess(new Procedure<Object>() { public void apply(Object o) { nextActor.tell(new EnrichedResult(request, o)); } });
-
askWithReplyTo
public static scala.concurrent.Future<java.lang.Object> askWithReplyTo(ActorRef actor, Function<ActorRef,java.lang.Object> messageFactory, long timeoutMillis)
A variation of ask which allows to implement "replyTo" pattern by including sender reference in message.final Future<Object> f = Patterns.askWithReplyTo( worker, replyTo -> new Request(replyTo), timeout);
-
ask
public static scala.concurrent.Future<java.lang.Object> ask(ActorSelection selection, java.lang.Object message, Timeout timeout)
Java API fororg.apache.pekko.pattern.ask
: Sends a message asynchronously and returns aFuture
holding the eventual reply message; this means that the targetpekko.actor.ActorSelection
needs to send the result to thesender
reference provided.The Future will be completed with an
pekko.pattern.AskTimeoutException
after the given timeout has expired; this is independent from any timeout applied while awaiting a result for this future (i.e. inAwait.result(..., timeout)
). A typical reason forAskTimeoutException
is that the recipient actor didn't send a reply.Warning: When using future callbacks, inside actors you need to carefully avoid closing over the containing actor’s object, i.e. do not call methods or access mutable state on the enclosing actor from within the callback. This would break the actor encapsulation and may introduce synchronization bugs and race conditions because the callback will be scheduled concurrently to the enclosing actor. Unfortunately there is not yet a way to detect these illegal accesses at compile time.
Recommended usage:
final Future<Object> f = Patterns.ask(selection, request, timeout); f.onSuccess(new Procedure<Object>() { public void apply(Object o) { nextActor.tell(new EnrichedResult(request, o)); } });
-
ask
public static java.util.concurrent.CompletionStage<java.lang.Object> ask(ActorSelection selection, java.lang.Object message, java.time.Duration timeout)
Java API fororg.apache.pekko.pattern.ask
: Sends a message asynchronously and returns aCompletionStage
holding the eventual reply message; this means that the targetpekko.actor.ActorSelection
needs to send the result to thesender
reference provided.The CompletionStage will be completed with an
pekko.pattern.AskTimeoutException
after the given timeout has expired; this is independent from any timeout applied while awaiting a result for this future (i.e. inAwait.result(..., timeout)
). A typical reason forAskTimeoutException
is that the recipient actor didn't send a reply.Warning: When using future callbacks, inside actors you need to carefully avoid closing over the containing actor’s object, i.e. do not call methods or access mutable state on the enclosing actor from within the callback. This would break the actor encapsulation and may introduce synchronization bugs and race conditions because the callback will be scheduled concurrently to the enclosing actor. Unfortunately there is not yet a way to detect these illegal accesses at compile time.
Recommended usage:
final CompletionStage<Object> f = Patterns.ask(selection, request, duration); f.thenRun(result -> nextActor.tell(new EnrichedResult(request, result)));
-
ask
public static scala.concurrent.Future<java.lang.Object> ask(ActorSelection selection, java.lang.Object message, long timeoutMillis)
Java API fororg.apache.pekko.pattern.ask
: Sends a message asynchronously and returns aFuture
holding the eventual reply message; this means that the targetpekko.actor.ActorSelection
needs to send the result to thesender
reference provided.The Future will be completed with an
pekko.pattern.AskTimeoutException
after the given timeout has expired; this is independent from any timeout applied while awaiting a result for this future (i.e. inAwait.result(..., timeout)
). A typical reason forAskTimeoutException
is that the recipient actor didn't send a reply.Warning: When using future callbacks, inside actors you need to carefully avoid closing over the containing actor’s object, i.e. do not call methods or access mutable state on the enclosing actor from within the callback. This would break the actor encapsulation and may introduce synchronization bugs and race conditions because the callback will be scheduled concurrently to the enclosing actor. Unfortunately there is not yet a way to detect these illegal accesses at compile time.
Recommended usage:
final Future<Object> f = Patterns.ask(selection, request, timeout); f.onSuccess(new Procedure<Object>() { public void apply(Object o) { nextActor.tell(new EnrichedResult(request, o)); } });
-
askWithReplyTo
public static scala.concurrent.Future<java.lang.Object> askWithReplyTo(ActorSelection selection, Function<ActorRef,java.lang.Object> messageFactory, long timeoutMillis)
A variation of ask which allows to implement "replyTo" pattern by including sender reference in message.final Future<Object> f = Patterns.askWithReplyTo( selection, replyTo -> new Request(replyTo), timeout);
-
askWithReplyTo
public static java.util.concurrent.CompletionStage<java.lang.Object> askWithReplyTo(ActorSelection selection, Function<ActorRef,java.lang.Object> messageFactory, java.time.Duration timeout)
A variation of ask which allows to implement "replyTo" pattern by including sender reference in message.final CompletionStage<Object> f = Patterns.askWithReplyTo( selection, replyTo -> new Request(replyTo), timeout);
-
pipe
public static <T> PipeToSupport.PipeableFuture<T> pipe(scala.concurrent.Future<T> future, scala.concurrent.ExecutionContext context)
Register an onComplete callback on thisFuture
to send the result to the givenpekko.actor.ActorRef
orpekko.actor.ActorSelection
. Returns the original Future to allow method chaining. If the future was completed with failure it is sent as apekko.actor.Status.Failure
to the recipient.Recommended usage example:
final Future<Object> f = Patterns.ask(worker, request, timeout); // apply some transformation (i.e. enrich with request info) final Future<Object> transformed = f.map(new org.apache.pekko.japi.Function<Object, Object>() { ... }); // send it on to the next operator Patterns.pipe(transformed, context).to(nextActor);
-
pipe
public static <T> PipeToSupport.PipeableCompletionStage<T> pipe(java.util.concurrent.CompletionStage<T> future, scala.concurrent.ExecutionContext context)
When thisCompletionStage
finishes, send its result to the givenpekko.actor.ActorRef
orpekko.actor.ActorSelection
. Returns the original CompletionStage to allow method chaining. If the future was completed with failure it is sent as apekko.actor.Status.Failure
to the recipient.Recommended usage example:
final CompletionStage<Object> f = Patterns.ask(worker, request, timeout); // apply some transformation (i.e. enrich with request info) final CompletionStage<Object> transformed = f.thenApply(result -> { ... }); // send it on to the next operator Patterns.pipe(transformed, context).to(nextActor);
-
gracefulStop
public static scala.concurrent.Future<java.lang.Boolean> gracefulStop(ActorRef target, scala.concurrent.duration.FiniteDuration timeout)
Returns aFuture
that will be completed with success (valuetrue
) when existing messages of the target actor has been processed and the actor has been terminated.Useful when you need to wait for termination or compose ordered termination of several actors.
If the target actor isn't terminated within the timeout the
Future
is completed with failurepekko.pattern.AskTimeoutException
.
-
gracefulStop
public static java.util.concurrent.CompletionStage<java.lang.Boolean> gracefulStop(ActorRef target, java.time.Duration timeout)
Returns aCompletionStage
that will be completed with success (valuetrue
) when existing messages of the target actor has been processed and the actor has been terminated.Useful when you need to wait for termination or compose ordered termination of several actors.
If the target actor isn't terminated within the timeout the
CompletionStage
is completed with failurepekko.pattern.AskTimeoutException
.
-
gracefulStop
public static scala.concurrent.Future<java.lang.Boolean> gracefulStop(ActorRef target, scala.concurrent.duration.FiniteDuration timeout, java.lang.Object stopMessage)
Returns aFuture
that will be completed with success (valuetrue
) when existing messages of the target actor has been processed and the actor has been terminated.Useful when you need to wait for termination or compose ordered termination of several actors.
If you want to invoke specialized stopping logic on your target actor instead of PoisonPill, you can pass your stop command as
stopMessage
parameterIf the target actor isn't terminated within the timeout the
Future
is completed with failurepekko.pattern.AskTimeoutException
.
-
gracefulStop
public static java.util.concurrent.CompletionStage<java.lang.Boolean> gracefulStop(ActorRef target, java.time.Duration timeout, java.lang.Object stopMessage)
Returns aCompletionStage
that will be completed with success (valuetrue
) when existing messages of the target actor has been processed and the actor has been terminated.Useful when you need to wait for termination or compose ordered termination of several actors.
If you want to invoke specialized stopping logic on your target actor instead of PoisonPill, you can pass your stop command as
stopMessage
parameterIf the target actor isn't terminated within the timeout the
CompletionStage
is completed with failurepekko.pattern.AskTimeoutException
.
-
after
public static <T> scala.concurrent.Future<T> after(scala.concurrent.duration.FiniteDuration duration, Scheduler scheduler, scala.concurrent.ExecutionContext context, java.util.concurrent.Callable<scala.concurrent.Future<T>> value)
Returns aFuture
that will be completed with the success or failure of the provided Callable after the specified duration.
-
after
public static <T> java.util.concurrent.CompletionStage<T> after(java.time.Duration duration, ClassicActorSystemProvider system, java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> value)
Returns aCompletionStage
that will be completed with the success or failure of the provided Callable after the specified duration.
-
after
public static <T> java.util.concurrent.CompletionStage<T> after(java.time.Duration duration, Scheduler scheduler, scala.concurrent.ExecutionContext context, java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> value)
Returns aCompletionStage
that will be completed with the success or failure of the provided Callable after the specified duration.
-
after
public static <T> scala.concurrent.Future<T> after(scala.concurrent.duration.FiniteDuration duration, Scheduler scheduler, scala.concurrent.ExecutionContext context, scala.concurrent.Future<T> value)
Deprecated.Use the overload one which accepts a Callable of Future instead. Since Akka 2.5.22.Returns aFuture
that will be completed with the success or failure of the provided Callable after the specified duration.
-
after
public static <T> java.util.concurrent.CompletionStage<T> after(java.time.Duration duration, Scheduler scheduler, scala.concurrent.ExecutionContext context, java.util.concurrent.CompletionStage<T> value)
Deprecated.Use the overloaded one which accepts a Callable of CompletionStage instead. Since Akka 2.5.22.Returns aCompletionStage
that will be completed with the success or failure of the provided value after the specified duration.
-
retry
public static <T> java.util.concurrent.CompletionStage<T> retry(java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> attempt, int attempts, scala.concurrent.ExecutionContext ec)
Returns an internally retryingCompletionStage
The first attempt will be made immediately, each subsequent attempt will be made immediately if the previous attempt failed.If attempts are exhausted the returned completion operator is simply the result of invoking attempt. Note that the attempt function will be invoked on the given execution context for subsequent tries and therefore must be thread safe (i.e. not touch unsafe mutable state).
-
retry
public static <T> java.util.concurrent.CompletionStage<T> retry(java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> attempt, java.util.function.BiPredicate<T,java.lang.Throwable> shouldRetry, int attempts, scala.concurrent.ExecutionContext ec)
Returns an internally retryingCompletionStage
.When the future is completed, the
shouldRetry
predicate is always been invoked with the result (ornull
if none) and the exception (ornull
if none). If theshouldRetry
predicate returns true, then a new attempt is made, each subsequent attempt will be made after the 'delay' return bydelayFunction
(the input next attempt count start from 1). Return an emptyOptional
instance for no delay.If attempts are exhausted the returned completion operator is simply the result of invoking attempt. Note that the attempt function will be invoked on the given execution context for subsequent tries and therefore must be thread safe (i.e. not touch unsafe mutable state).
- Parameters:
attempt
- the function to be attemptedshouldRetry
- the predicate to determine if the attempt should be retriedattempts
- the maximum number of attemptsec
- the execution context- Returns:
- the result
CompletionStage
which maybe retried - Since:
- 1.1.0
-
retry
public static <T> java.util.concurrent.CompletionStage<T> retry(java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> attempt, int attempts, java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, ClassicActorSystemProvider system)
Returns an internally retryingCompletionStage
The first attempt will be made immediately, each subsequent attempt will be made with a backoff time, if the previous attempt failed.If attempts are exhausted the returned future is simply the result of invoking attempt. Note that the attempt function will be invoked on the given execution context for subsequent tries and therefore must be thread safe (i.e. not touch unsafe mutable state).
- Parameters:
minBackoff
- minimum (initial) duration until the child actor will started again, if it is terminatedmaxBackoff
- the exponential back-off is capped to this durationrandomFactor
- after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.0.2
adds up to20%
delay. In order to skip this additional delay pass in0
.
-
retry
public static <T> java.util.concurrent.CompletionStage<T> retry(java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> attempt, java.util.function.BiPredicate<T,java.lang.Throwable> shouldRetry, int attempts, java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, ClassicActorSystemProvider system)
Returns an internally retryingCompletionStage
.When the future is completed, the
shouldRetry
predicate is always been invoked with the result (ornull
if none) and the exception (ornull
if none). If theshouldRetry
predicate returns true, then a new attempt is made, each subsequent attempt will be made after the 'delay' return bydelayFunction
(the input next attempt count start from 1). Return an emptyOptional
instance for no delay.If attempts are exhausted the returned future is simply the result of invoking attempt. Note that the attempt function will be invoked on the given execution context for subsequent tries and therefore must be thread safe (i.e. not touch unsafe mutable state).
- Parameters:
attempt
- the function to be attemptedshouldRetry
- the predicate to determine if the attempt should be retriedattempts
- the maximum number of attemptsminBackoff
- minimum (initial) duration until the child actor will started again, if it is terminatedmaxBackoff
- the exponential back-off is capped to this durationrandomFactor
- after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.0.2
adds up to20%
delay. In order to skip this additional delay pass in0
.system
- the actor system- Returns:
- the result
CompletionStage
which maybe retried - Since:
- 1.1.0
-
retry
public static <T> java.util.concurrent.CompletionStage<T> retry(java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> attempt, int attempts, java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, Scheduler scheduler, scala.concurrent.ExecutionContext ec)
Returns an internally retryingCompletionStage
The first attempt will be made immediately, each subsequent attempt will be made with a backoff time, if the previous attempt failed.If attempts are exhausted the returned future is simply the result of invoking attempt. Note that the attempt function will be invoked on the given execution context for subsequent tries and therefore must be thread safe (i.e. not touch unsafe mutable state).
- Parameters:
minBackoff
- minimum (initial) duration until the child actor will started again, if it is terminatedmaxBackoff
- the exponential back-off is capped to this durationrandomFactor
- after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.0.2
adds up to20%
delay. In order to skip this additional delay pass in0
.
-
retry
public static <T> java.util.concurrent.CompletionStage<T> retry(java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> attempt, java.util.function.BiPredicate<T,java.lang.Throwable> shouldRetry, int attempts, java.time.Duration minBackoff, java.time.Duration maxBackoff, double randomFactor, Scheduler scheduler, scala.concurrent.ExecutionContext ec)
Returns an internally retryingCompletionStage
.When the future is completed, the
shouldRetry
predicate is always been invoked with the result (ornull
if none) and the exception (ornull
if none). If theshouldRetry
predicate returns true, then a new attempt is made, each subsequent attempt will be made after the 'delay' return bydelayFunction
(the input next attempt count start from 1). Return an emptyOptional
instance for no delay.If attempts are exhausted the returned future is simply the result of invoking attempt. Note that the attempt function will be invoked on the given execution context for subsequent tries and therefore must be thread safe (i.e. not touch unsafe mutable state).
- Parameters:
attempt
- the function to be attemptedshouldRetry
- the predicate to determine if the attempt should be retriedattempts
- the maximum number of attemptsminBackoff
- minimum (initial) duration until the child actor will started again, if it is terminatedmaxBackoff
- the exponential back-off is capped to this durationrandomFactor
- after calculation of the exponential back-off an additional random delay based on this factor is added, e.g.0.2
adds up to20%
delay. In order to skip this additional delay pass in0
.scheduler
- the scheduler for scheduling a delayec
- the execution context- Returns:
- the result
CompletionStage
which maybe retried - Since:
- 1.1.0
-
retry
public static <T> scala.concurrent.Future<T> retry(java.util.concurrent.Callable<scala.concurrent.Future<T>> attempt, int attempts, scala.concurrent.duration.FiniteDuration delay, Scheduler scheduler, scala.concurrent.ExecutionContext context)
Returns an internally retryingFuture
The first attempt will be made immediately, and each subsequent attempt will be made after 'delay'. A scheduler (eg context.system.scheduler) must be provided to delay each retryIf attempts are exhausted the returned future is simply the result of invoking attempt. Note that the attempt function will be invoked on the given execution context for subsequent tries and therefore must be thread safe (i.e. not touch unsafe mutable state).
-
retry
public static <T> java.util.concurrent.CompletionStage<T> retry(java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> attempt, int attempts, java.time.Duration delay, ClassicActorSystemProvider system)
Returns an internally retryingCompletionStage
The first attempt will be made immediately, and each subsequent attempt will be made after 'delay'. A scheduler (eg context.system.scheduler) must be provided to delay each retryIf attempts are exhausted the returned completion operator is simply the result of invoking attempt. Note that the attempt function will be invoked on the given execution context for subsequent tries and therefore must be thread safe (i.e. not touch unsafe mutable state).
-
retry
public static <T> java.util.concurrent.CompletionStage<T> retry(java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> attempt, java.util.function.BiPredicate<T,java.lang.Throwable> shouldRetry, int attempts, java.time.Duration delay, ClassicActorSystemProvider system)
Returns an internally retryingCompletionStage
.When the future is completed, the
shouldRetry
predicate is always been invoked with the result (ornull
if none) and the exception (ornull
if none). If theshouldRetry
predicate returns true, then a new attempt is made, each subsequent attempt will be made after the 'delay' return bydelayFunction
(the input next attempt count start from 1). Return an emptyOptional
instance for no delay.If attempts are exhausted the returned completion operator is simply the result of invoking attempt. Note that the attempt function will be invoked on the given execution context for subsequent tries and therefore must be thread safe (i.e. not touch unsafe mutable state).
- Parameters:
attempt
- the function to be attemptedshouldRetry
- the predicate to determine if the attempt should be retriedattempts
- the maximum number of attemptsdelay
- the delay between each attemptsystem
- the actor system- Returns:
- the result
CompletionStage
which maybe retried - Since:
- 1.1.0
-
retry
public static <T> java.util.concurrent.CompletionStage<T> retry(java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> attempt, int attempts, java.time.Duration delay, Scheduler scheduler, scala.concurrent.ExecutionContext ec)
Returns an internally retryingCompletionStage
The first attempt will be made immediately, and each subsequent attempt will be made after 'delay'. A scheduler (eg context.system.scheduler) must be provided to delay each retryIf attempts are exhausted the returned completion operator is simply the result of invoking attempt. Note that the attempt function will be invoked on the given execution context for subsequent tries and therefore must be thread safe (i.e. not touch unsafe mutable state).
-
retry
public static <T> java.util.concurrent.CompletionStage<T> retry(java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> attempt, java.util.function.BiPredicate<T,java.lang.Throwable> shouldRetry, int attempts, java.time.Duration delay, Scheduler scheduler, scala.concurrent.ExecutionContext ec)
Returns an internally retryingCompletionStage
.When the future is completed, the
shouldRetry
predicate is always been invoked with the result (ornull
if none) and the exception (ornull
if none). If theshouldRetry
predicate returns true, then a new attempt is made, each subsequent attempt will be made after the 'delay' return bydelayFunction
(the input next attempt count start from 1). Return an emptyOptional
instance for no delay.If attempts are exhausted the returned completion operator is simply the result of invoking attempt. Note that the attempt function will be invoked on the given execution context for subsequent tries and therefore must be thread safe (i.e. not touch unsafe mutable state).
- Parameters:
attempt
- the function to be attemptedshouldRetry
- the predicate to determine if the attempt should be retriedattempts
- the maximum number of attemptsdelay
- the delay between each attemptscheduler
- the scheduler for scheduling a delayec
- the execution context- Returns:
- the result
CompletionStage
which maybe retried * - Since:
- 1.1.0
-
retry
public static <T> java.util.concurrent.CompletionStage<T> retry(java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> attempt, int attempts, java.util.function.IntFunction<java.util.Optional<java.time.Duration>> delayFunction, Scheduler scheduler, scala.concurrent.ExecutionContext context)
Returns an internally retryingCompletionStage
. The first attempt will be made immediately, each subsequent attempt will be made after the 'delay' return bydelayFunction
(the input next attempt count start from 1). Return an emptyOptional
instance for no delay. A scheduler (eg context.system.scheduler) must be provided to delay each retry. You could provide a function to generate the next delay duration after first attempt, this function should never returnnull
, otherwise anIllegalArgumentException
will be through.If attempts are exhausted the returned future is simply the result of invoking attempt. Note that the attempt function will be invoked on the given execution context for subsequent tries and therefore must be thread safe (i.e. not touch unsafe mutable state).
-
retry
public static <T> java.util.concurrent.CompletionStage<T> retry(java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> attempt, java.util.function.BiPredicate<T,java.lang.Throwable> shouldRetry, int attempts, java.util.function.IntFunction<java.util.Optional<java.time.Duration>> delayFunction, Scheduler scheduler, scala.concurrent.ExecutionContext context)
Returns an internally retryingCompletionStage
.When the future is completed, the
shouldRetry
predicate is always been invoked with the result (ornull
if none) and the exception (ornull
if none). If theshouldRetry
predicate returns true, then a new attempt is made, each subsequent attempt will be made after the 'delay' return bydelayFunction
(the input next attempt count start from 1). Return an emptyOptional
instance for no delay.A scheduler (eg context.system.scheduler) must be provided to delay each retry. You could provide a function to generate the next delay duration after first attempt, this function should never return
null
, otherwise anIllegalArgumentException
will be through.If attempts are exhausted the returned future is simply the result of invoking attempt. Note that the attempt function will be invoked on the given execution context for subsequent tries and therefore must be thread safe (i.e. not touch unsafe mutable state).
- Parameters:
attempt
- the function to be attemptedshouldRetry
- the predicate to determine if the attempt should be retriedattempts
- the maximum number of attemptsdelayFunction
- the function to generate the next delay duration,None
for no delayscheduler
- the scheduler for scheduling a delaycontext
- the execution context- Returns:
- the result
CompletionStage
which maybe retried - Since:
- 1.1.0
-
-