object Patterns
Java API: for Pekko patterns such as ask
, pipe
and others which work with java.util.concurrent.CompletionStage.
- Source
- Patterns.scala
- Alphabetic
- By Inheritance
- Patterns
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def after[T](duration: Duration, scheduler: Scheduler, context: ExecutionContext, value: Callable[CompletionStage[T]]): CompletionStage[T]
Returns a java.util.concurrent.CompletionStage that will be completed with the success or failure of the provided Callable after the specified duration.
- def after[T](duration: Duration, system: ClassicActorSystemProvider, value: Callable[CompletionStage[T]]): CompletionStage[T]
Returns a java.util.concurrent.CompletionStage that will be completed with the success or failure of the provided Callable after the specified duration.
- def after[T](duration: FiniteDuration, scheduler: Scheduler, context: ExecutionContext, value: Callable[Future[T]]): Future[T]
Returns a scala.concurrent.Future that will be completed with the success or failure of the provided Callable after the specified duration.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def ask(selection: ActorSelection, message: Any, timeoutMillis: Long): Future[AnyRef]
Java API for `org.apache.pekko.pattern.ask`: Sends a message asynchronously and returns a scala.concurrent.Future holding the eventual reply message; this means that the target pekko.actor.ActorSelection needs to send the result to the
sender
reference provided.Java API for `org.apache.pekko.pattern.ask`: Sends a message asynchronously and returns a scala.concurrent.Future holding the eventual reply message; this means that the target pekko.actor.ActorSelection needs to send the result to the
sender
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. in
Await.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)); } });
- def ask(selection: ActorSelection, message: Any, timeout: Duration): CompletionStage[AnyRef]
Java API for `org.apache.pekko.pattern.ask`: Sends a message asynchronously and returns a java.util.concurrent.CompletionStage holding the eventual reply message; this means that the target pekko.actor.ActorSelection needs to send the result to the
sender
reference provided.Java API for `org.apache.pekko.pattern.ask`: Sends a message asynchronously and returns a java.util.concurrent.CompletionStage holding the eventual reply message; this means that the target pekko.actor.ActorSelection needs to send the result to the
sender
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. in
Await.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)));
- def ask(selection: ActorSelection, message: Any, timeout: Timeout): Future[AnyRef]
Java API for `org.apache.pekko.pattern.ask`: Sends a message asynchronously and returns a scala.concurrent.Future holding the eventual reply message; this means that the target pekko.actor.ActorSelection needs to send the result to the
sender
reference provided.Java API for `org.apache.pekko.pattern.ask`: Sends a message asynchronously and returns a scala.concurrent.Future holding the eventual reply message; this means that the target pekko.actor.ActorSelection needs to send the result to the
sender
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. in
Await.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)); } });
- def ask(actor: ActorRef, message: Any, timeoutMillis: Long): Future[AnyRef]
Java API for `org.apache.pekko.pattern.ask`: Sends a message asynchronously and returns a scala.concurrent.Future holding the eventual reply message; this means that the target actor needs to send the result to the
sender
reference provided.Java API for `org.apache.pekko.pattern.ask`: Sends a message asynchronously and returns a scala.concurrent.Future holding the eventual reply message; this means that the target actor needs to send the result to the
sender
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. in
Await.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)); } });
- def ask(actor: ActorRef, message: Any, timeout: Duration): CompletionStage[AnyRef]
Java API for `org.apache.pekko.pattern.ask`: Sends a message asynchronously and returns a java.util.concurrent.CompletionStage holding the eventual reply message; this means that the target actor needs to send the result to the
sender
reference provided.Java API for `org.apache.pekko.pattern.ask`: Sends a message asynchronously and returns a java.util.concurrent.CompletionStage holding the eventual reply message; this means that the target actor needs to send the result to the
sender
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. in
Await.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)));
- def ask(actor: ActorRef, message: Any, timeout: Timeout): Future[AnyRef]
Java API for `org.apache.pekko.pattern.ask`: Sends a message asynchronously and returns a scala.concurrent.Future holding the eventual reply message; this means that the target actor needs to send the result to the
sender
reference provided.Java API for `org.apache.pekko.pattern.ask`: Sends a message asynchronously and returns a scala.concurrent.Future holding the eventual reply message; this means that the target actor needs to send the result to the
sender
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. in
Await.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)); } });
- def askWithReplyTo(selection: ActorSelection, messageFactory: Function[ActorRef, Any], timeout: Duration): CompletionStage[AnyRef]
A variation of ask which allows to implement "replyTo" pattern by including sender reference in message.
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);
- def askWithReplyTo(selection: ActorSelection, messageFactory: Function[ActorRef, Any], timeoutMillis: Long): Future[AnyRef]
A variation of ask which allows to implement "replyTo" pattern by including sender reference in message.
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);
- def askWithReplyTo(actor: ActorRef, messageFactory: Function[ActorRef, Any], timeoutMillis: Long): Future[AnyRef]
A variation of ask which allows to implement "replyTo" pattern by including sender reference in message.
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);
- def askWithReplyTo(actor: ActorRef, messageFactory: Function[ActorRef, Any], timeout: Duration): CompletionStage[AnyRef]
A variation of ask which allows to implement "replyTo" pattern by including sender reference in message.
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);
- actor
the actor to be asked
- messageFactory
function taking an actor ref and returning the message to be sent
- timeout
the timeout for the response before failing the returned completion stage
- def askWithReplyTo(actor: ActorRef, messageFactory: Function[ActorRef, Any], timeout: Timeout): Future[AnyRef]
A variation of ask which allows to implement "replyTo" pattern by including sender reference in message.
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);
- def askWithStatus(actor: ActorRef, message: Any, timeout: Duration): CompletionStage[AnyRef]
Use for messages whose response is known to be a pekko.pattern.StatusReply.
Use for messages whose response is known to be a pekko.pattern.StatusReply. When a pekko.pattern.StatusReply#success response arrives the future is completed with the wrapped value, if a pekko.pattern.StatusReply#error arrives the future is instead failed.
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def gracefulStop(target: ActorRef, timeout: Duration, stopMessage: Any): CompletionStage[Boolean]
Returns a java.util.concurrent.CompletionStage that will be completed with success (value
true
) when existing messages of the target actor has been processed and the actor has been terminated.Returns a java.util.concurrent.CompletionStage that will be completed with success (value
true
) 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 java.util.concurrent.CompletionStage is completed with failure pekko.pattern.AskTimeoutException.
- def gracefulStop(target: ActorRef, timeout: FiniteDuration, stopMessage: Any): Future[Boolean]
Returns a scala.concurrent.Future that will be completed with success (value
true
) when existing messages of the target actor has been processed and the actor has been terminated.Returns a scala.concurrent.Future that will be completed with success (value
true
) 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 scala.concurrent.Future is completed with failure pekko.pattern.AskTimeoutException.
- def gracefulStop(target: ActorRef, timeout: Duration): CompletionStage[Boolean]
Returns a java.util.concurrent.CompletionStage that will be completed with success (value
true
) when existing messages of the target actor has been processed and the actor has been terminated.Returns a java.util.concurrent.CompletionStage that will be completed with success (value
true
) 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 java.util.concurrent.CompletionStage is completed with failure pekko.pattern.AskTimeoutException.
- def gracefulStop(target: ActorRef, timeout: FiniteDuration): Future[Boolean]
Returns a scala.concurrent.Future that will be completed with success (value
true
) when existing messages of the target actor has been processed and the actor has been terminated.Returns a scala.concurrent.Future that will be completed with success (value
true
) 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 scala.concurrent.Future is completed with failure pekko.pattern.AskTimeoutException.
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def pipe[T](future: CompletionStage[T], context: ExecutionContext): pattern.PipeableCompletionStage[T]
When this java.util.concurrent.CompletionStage finishes, send its result to the given pekko.actor.ActorRef or pekko.actor.ActorSelection.
When this java.util.concurrent.CompletionStage finishes, send its result to the given pekko.actor.ActorRef or pekko.actor.ActorSelection. Returns the original CompletionStage to allow method chaining. If the future was completed with failure it is sent as a pekko.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);
- def pipe[T](future: Future[T], context: ExecutionContext): pattern.PipeableFuture[T]
Register an onComplete callback on this scala.concurrent.Future to send the result to the given pekko.actor.ActorRef or pekko.actor.ActorSelection.
Register an onComplete callback on this scala.concurrent.Future to send the result to the given pekko.actor.ActorRef or pekko.actor.ActorSelection. Returns the original Future to allow method chaining. If the future was completed with failure it is sent as a pekko.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);
- def retry[T](attempt: Callable[CompletionStage[T]], attempts: Int, delayFunction: IntFunction[Optional[Duration]], scheduler: Scheduler, context: ExecutionContext): CompletionStage[T]
Returns an internally retrying java.util.concurrent.CompletionStage.
Returns an internally retrying java.util.concurrent.CompletionStage. The first attempt will be made immediately, each subsequent attempt will be made after the 'delay' return by
delayFunction
(the input next attempt count start from 1). Return an empty Optional 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 an IllegalArgumentException 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 (not touch unsafe mutable state).
- def retry[T](attempt: Callable[CompletionStage[T]], attempts: Int, delay: Duration, scheduler: Scheduler, ec: ExecutionContext): CompletionStage[T]
Returns an internally retrying java.util.concurrent.CompletionStage The first attempt will be made immediately, and each subsequent attempt will be made after 'delay'.
Returns an internally retrying java.util.concurrent.CompletionStage 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).
- def retry[T](attempt: Callable[CompletionStage[T]], attempts: Int, delay: Duration, system: ClassicActorSystemProvider): CompletionStage[T]
Returns an internally retrying java.util.concurrent.CompletionStage The first attempt will be made immediately, and each subsequent attempt will be made after 'delay'.
Returns an internally retrying java.util.concurrent.CompletionStage 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).
- def retry[T](attempt: Callable[Future[T]], attempts: Int, delay: FiniteDuration, scheduler: Scheduler, context: ExecutionContext): Future[T]
Returns an internally retrying scala.concurrent.Future The first attempt will be made immediately, and each subsequent attempt will be made after 'delay'.
Returns an internally retrying scala.concurrent.Future 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 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 (not touch unsafe mutable state).
- def retry[T](attempt: Callable[CompletionStage[T]], attempts: Int, minBackoff: Duration, maxBackoff: Duration, randomFactor: Double, scheduler: Scheduler, ec: ExecutionContext): CompletionStage[T]
Returns an internally retrying java.util.concurrent.CompletionStage The first attempt will be made immediately, each subsequent attempt will be made with a backoff time, if the previous attempt failed.
Returns an internally retrying java.util.concurrent.CompletionStage 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 (not touch unsafe mutable state).
- minBackoff
minimum (initial) duration until the child actor will started again, if it is terminated
- maxBackoff
the exponential back-off is capped to this duration
- randomFactor
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
.
- def retry[T](attempt: Callable[CompletionStage[T]], attempts: Int, minBackoff: Duration, maxBackoff: Duration, randomFactor: Double, system: ClassicActorSystemProvider): CompletionStage[T]
Returns an internally retrying java.util.concurrent.CompletionStage The first attempt will be made immediately, each subsequent attempt will be made with a backoff time, if the previous attempt failed.
Returns an internally retrying java.util.concurrent.CompletionStage 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 (not touch unsafe mutable state).
- minBackoff
minimum (initial) duration until the child actor will started again, if it is terminated
- maxBackoff
the exponential back-off is capped to this duration
- randomFactor
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
.
- def retry[T](attempt: Callable[CompletionStage[T]], attempts: Int, ec: ExecutionContext): CompletionStage[T]
Returns an internally retrying java.util.concurrent.CompletionStage The first attempt will be made immediately, each subsequent attempt will be made immediately if the previous attempt failed.
Returns an internally retrying java.util.concurrent.CompletionStage 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 (not touch unsafe mutable state).
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def after[T](duration: Duration, scheduler: Scheduler, context: ExecutionContext, value: CompletionStage[T]): CompletionStage[T]
Returns a java.util.concurrent.CompletionStage that will be completed with the success or failure of the provided value after the specified duration.
Returns a java.util.concurrent.CompletionStage that will be completed with the success or failure of the provided value after the specified duration.
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.5.22) Use the overloaded one which accepts a Callable of CompletionStage instead.
- def after[T](duration: FiniteDuration, scheduler: Scheduler, context: ExecutionContext, value: Future[T]): Future[T]
Returns a scala.concurrent.Future that will be completed with the success or failure of the provided Callable after the specified duration.
Returns a scala.concurrent.Future that will be completed with the success or failure of the provided Callable after the specified duration.
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.5.22) Use the overload one which accepts a Callable of Future instead.
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)