Class PatternsCS
- java.lang.Object
-
- akka.pattern.PatternsCS
-
public class PatternsCS extends java.lang.Object
Deprecated.Use Patterns instead. Since 2.5.19.Java 8+ API for Akka patterns such asask
,pipe
and others which work withCompletionStage
.For working with Scala
Future
from Java you may want to usePatterns
instead.
-
-
Constructor Summary
Constructors Constructor Description PatternsCS()
Deprecated.
-
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, Scheduler scheduler, scala.concurrent.ExecutionContext context, java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> value)
Deprecated.Use Patterns.after instead.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 Patterns.after which accepts java.time.Duration and Callable of CompletionStage instead.static <T> java.util.concurrent.CompletionStage<T>
after(scala.concurrent.duration.FiniteDuration duration, Scheduler scheduler, scala.concurrent.ExecutionContext context, java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> value)
Deprecated.Use the overloaded one which accepts java.time.Duration instead.static <T> java.util.concurrent.CompletionStage<T>
after(scala.concurrent.duration.FiniteDuration duration, Scheduler scheduler, scala.concurrent.ExecutionContext context, java.util.concurrent.CompletionStage<T> value)
Deprecated.Use Patterns.after which accepts java.time.Duration and Callable of CompletionStage instead.static java.util.concurrent.CompletionStage<java.lang.Object>
ask(ActorRef actor, java.lang.Object message, long timeoutMillis)
Deprecated.Use Pattens.ask which accepts java.time.Duration instead.static java.util.concurrent.CompletionStage<java.lang.Object>
ask(ActorRef actor, java.lang.Object message, Timeout timeout)
Deprecated.Use the overloaded one which accepts java.time.Duration instead.static java.util.concurrent.CompletionStage<java.lang.Object>
ask(ActorRef actor, java.lang.Object message, java.time.Duration timeout)
Deprecated.Use Patterns.ask instead.static java.util.concurrent.CompletionStage<java.lang.Object>
ask(ActorSelection selection, java.lang.Object message, long timeoutMillis)
Deprecated.Use Pattens.ask which accepts java.time.Duration instead.static java.util.concurrent.CompletionStage<java.lang.Object>
ask(ActorSelection selection, java.lang.Object message, Timeout timeout)
Deprecated.Use the overloaded one which accepts java.time.Duration instead.static java.util.concurrent.CompletionStage<java.lang.Object>
ask(ActorSelection selection, java.lang.Object message, java.time.Duration timeout)
Deprecated.Use Patterns.ask instead.static java.util.concurrent.CompletionStage<java.lang.Object>
askWithReplyTo(ActorRef actor, Function<ActorRef,java.lang.Object> messageFactory, long timeoutMillis)
Deprecated.Use Pattens.askWithReplyTo which accepts java.time.Duration instead.static java.util.concurrent.CompletionStage<java.lang.Object>
askWithReplyTo(ActorRef actor, Function<ActorRef,java.lang.Object> messageFactory, Timeout timeout)
Deprecated.Use the overloaded one which accepts java.time.Duration instead.static java.util.concurrent.CompletionStage<java.lang.Object>
askWithReplyTo(ActorRef actor, Function<ActorRef,java.lang.Object> messageFactory, java.time.Duration timeout)
Deprecated.Use Pattens.askWithReplyTo instead.static java.util.concurrent.CompletionStage<java.lang.Object>
askWithReplyTo(ActorSelection selection, Function<ActorRef,java.lang.Object> messageFactory, long timeoutMillis)
Deprecated.Use Pattens.askWithReplyTo which accepts java.time.Duration instead.static java.util.concurrent.CompletionStage<java.lang.Boolean>
gracefulStop(ActorRef target, java.time.Duration timeout)
Deprecated.Use Patterns.gracefulStop instead.static java.util.concurrent.CompletionStage<java.lang.Boolean>
gracefulStop(ActorRef target, java.time.Duration timeout, java.lang.Object stopMessage)
Deprecated.Use Patterns.gracefulStop instead.static java.util.concurrent.CompletionStage<java.lang.Boolean>
gracefulStop(ActorRef target, scala.concurrent.duration.FiniteDuration timeout)
Deprecated.Use the overloaded one which accepts java.time.Duration instead.static java.util.concurrent.CompletionStage<java.lang.Boolean>
gracefulStop(ActorRef target, scala.concurrent.duration.FiniteDuration timeout, java.lang.Object stopMessage)
Deprecated.Use the overloaded one which accepts java.time.Duration instead.static <T> PipeToSupport.PipeableCompletionStage<T>
pipe(java.util.concurrent.CompletionStage<T> future, scala.concurrent.ExecutionContext context)
Deprecated.Use Patterns.pipe instead.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)
Deprecated.Use Patterns.retry instead.
-
-
-
Method Detail
-
ask
public static java.util.concurrent.CompletionStage<java.lang.Object> ask(ActorRef actor, java.lang.Object message, Timeout timeout)
Deprecated.Use the overloaded one which accepts java.time.Duration instead. Since 2.5.15.Java API forakka.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
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 = PatternsCS.ask(worker, request, timeout); f.thenRun(result -> nextActor.tell(new EnrichedResult(request, result)));
-
ask
public static java.util.concurrent.CompletionStage<java.lang.Object> ask(ActorRef actor, java.lang.Object message, java.time.Duration timeout)
Deprecated.Use Patterns.ask instead. Since 2.5.19.Java API forakka.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
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 = PatternsCS.ask(worker, request, duration); f.thenRun(result -> nextActor.tell(new EnrichedResult(request, result)));
-
askWithReplyTo
public static java.util.concurrent.CompletionStage<java.lang.Object> askWithReplyTo(ActorRef actor, Function<ActorRef,java.lang.Object> messageFactory, Timeout timeout)
Deprecated.Use the overloaded one which accepts java.time.Duration instead. Since 2.5.15.A variation of ask which allows to implement "replyTo" pattern by including sender reference in message.final CompletionStage<Object> f = PatternsCS.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 operator
-
askWithReplyTo
public static java.util.concurrent.CompletionStage<java.lang.Object> askWithReplyTo(ActorRef actor, Function<ActorRef,java.lang.Object> messageFactory, java.time.Duration timeout)
Deprecated.Use Pattens.askWithReplyTo instead. Since 2.5.19.A variation of ask which allows to implement "replyTo" pattern by including sender reference in message.final CompletionStage<Object> f = PatternsCS.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 java.util.concurrent.CompletionStage<java.lang.Object> ask(ActorRef actor, java.lang.Object message, long timeoutMillis)
Deprecated.Use Pattens.ask which accepts java.time.Duration instead. Since 2.5.19.Java API forakka.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
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 = PatternsCS.ask(worker, request, timeout); f.thenRun(result -> nextActor.tell(new EnrichedResult(request, result)));
-
askWithReplyTo
public static java.util.concurrent.CompletionStage<java.lang.Object> askWithReplyTo(ActorRef actor, Function<ActorRef,java.lang.Object> messageFactory, long timeoutMillis)
Deprecated.Use Pattens.askWithReplyTo which accepts java.time.Duration instead. Since 2.5.19.A variation of ask which allows to implement "replyTo" pattern by including sender reference in message.final CompletionStage<Object> f = PatternsCS.askWithReplyTo( worker, replyTo -> new Request(replyTo), timeout);
- Parameters:
actor
- the actor to be askedmessageFactory
- function taking an actor ref to reply to and returning the message to be senttimeoutMillis
- the timeout for the response before failing the returned completion operator
-
ask
public static java.util.concurrent.CompletionStage<java.lang.Object> ask(ActorSelection selection, java.lang.Object message, Timeout timeout)
Deprecated.Use the overloaded one which accepts java.time.Duration instead. Since 2.5.15.Java API forakka.pattern.ask
: Sends a message asynchronously and returns aCompletionStage
holding the eventual reply message; this means that the targetActorSelection
needs to send the result to thesender
reference provided.The CompletionStage will be completed with an
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 = PatternsCS.ask(selection, request, timeout); f.thenRun(result -> nextActor.tell(new EnrichedResult(request, result)));
-
ask
public static java.util.concurrent.CompletionStage<java.lang.Object> ask(ActorSelection selection, java.lang.Object message, java.time.Duration timeout)
Deprecated.Use Patterns.ask instead. Since 2.5.19.Java API forakka.pattern.ask
: Sends a message asynchronously and returns aCompletionStage
holding the eventual reply message; this means that the targetActorSelection
needs to send the result to thesender
reference provided.The CompletionStage will be completed with an
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 = PatternsCS.ask(selection, request, duration); f.thenRun(result -> nextActor.tell(new EnrichedResult(request, result)));
-
ask
public static java.util.concurrent.CompletionStage<java.lang.Object> ask(ActorSelection selection, java.lang.Object message, long timeoutMillis)
Deprecated.Use Pattens.ask which accepts java.time.Duration instead. Since 2.5.19.Java API forakka.pattern.ask
: Sends a message asynchronously and returns aCompletionStage
holding the eventual reply message; this means that the targetActorSelection
needs to send the result to thesender
reference provided.The CompletionStage will be completed with an
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 = PatternsCS.ask(selection, request, timeout); f.thenRun(result -> nextActor.tell(new EnrichedResult(request, result)));
-
askWithReplyTo
public static java.util.concurrent.CompletionStage<java.lang.Object> askWithReplyTo(ActorSelection selection, Function<ActorRef,java.lang.Object> messageFactory, long timeoutMillis)
Deprecated.Use Pattens.askWithReplyTo which accepts java.time.Duration instead. Since 2.5.19.A variation of ask which allows to implement "replyTo" pattern by including sender reference in message.final CompletionStage<Object> f = Patterns.askWithReplyTo( selection, askSender -> new Request(askSender), timeout);
-
pipe
public static <T> PipeToSupport.PipeableCompletionStage<T> pipe(java.util.concurrent.CompletionStage<T> future, scala.concurrent.ExecutionContext context)
Deprecated.Use Patterns.pipe instead. Since 2.5.19.When thisCompletionStage
finishes, send its result to the givenActorRef
orActorSelection
. Returns the original CompletionStage to allow method chaining. If the future was completed with failure it is sent as aStatus.Failure
to the recipient.Recommended usage example:
final CompletionStage<Object> f = PatternsCS.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 PatternsCS.pipe(transformed, context).to(nextActor);
-
gracefulStop
public static java.util.concurrent.CompletionStage<java.lang.Boolean> gracefulStop(ActorRef target, scala.concurrent.duration.FiniteDuration timeout)
Deprecated.Use the overloaded one which accepts java.time.Duration instead. Since 2.5.12.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 failureAskTimeoutException
.
-
gracefulStop
public static java.util.concurrent.CompletionStage<java.lang.Boolean> gracefulStop(ActorRef target, java.time.Duration timeout)
Deprecated.Use Patterns.gracefulStop instead. Since 2.5.19.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 failureAskTimeoutException
.
-
gracefulStop
public static java.util.concurrent.CompletionStage<java.lang.Boolean> gracefulStop(ActorRef target, scala.concurrent.duration.FiniteDuration timeout, java.lang.Object stopMessage)
Deprecated.Use the overloaded one which accepts java.time.Duration instead. Since 2.5.12.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 failureAskTimeoutException
.
-
gracefulStop
public static java.util.concurrent.CompletionStage<java.lang.Boolean> gracefulStop(ActorRef target, java.time.Duration timeout, java.lang.Object stopMessage)
Deprecated.Use Patterns.gracefulStop instead. Since 2.5.19.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 failureAskTimeoutException
.
-
after
public static <T> java.util.concurrent.CompletionStage<T> after(scala.concurrent.duration.FiniteDuration duration, Scheduler scheduler, scala.concurrent.ExecutionContext context, java.util.concurrent.Callable<java.util.concurrent.CompletionStage<T>> value)
Deprecated.Use the overloaded one which accepts java.time.Duration instead. Since 2.5.12.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)
Deprecated.Use Patterns.after instead. Since 2.5.19.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(scala.concurrent.duration.FiniteDuration duration, Scheduler scheduler, scala.concurrent.ExecutionContext context, java.util.concurrent.CompletionStage<T> value)
Deprecated.Use Patterns.after which accepts java.time.Duration and Callable of CompletionStage instead. Since 2.5.22.Returns aCompletionStage
that will be completed with the success or failure of the provided value 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 Patterns.after which accepts java.time.Duration and Callable of CompletionStage instead. Since 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, java.time.Duration delay, Scheduler scheduler, scala.concurrent.ExecutionContext ec)
Deprecated.Use Patterns.retry instead. Since 2.5.19.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 retry 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 (not touch unsafe mutable state).
-
-