Packages

o

akka.pattern

PatternsCS

object PatternsCS

Java 8+ API for Akka patterns such as ask, pipe and others which work with java.util.concurrent.CompletionStage.

For working with Scala scala.concurrent.Future from Java you may want to use akka.pattern.Patterns instead.

Annotations
@deprecated
Deprecated

(Since version 2.5.19) Use Patterns instead.

Source
Patterns.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PatternsCS
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. 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 2.5.22) Use Patterns.after which accepts java.time.Duration and Callable of CompletionStage instead.

  2. def after[T](duration: FiniteDuration, 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 2.5.22) Use Patterns.after which accepts java.time.Duration and Callable of CompletionStage instead.

  3. 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.

    Returns a java.util.concurrent.CompletionStage that will be completed with the success or failure of the provided Callable after the specified duration.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.19) Use Patterns.after instead.

  4. def after[T](duration: FiniteDuration, 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.

    Returns a java.util.concurrent.CompletionStage that will be completed with the success or failure of the provided Callable after the specified duration.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.12) Use the overloaded one which accepts java.time.Duration instead.

  5. def ask(selection: ActorSelection, message: Any, timeoutMillis: Long): CompletionStage[AnyRef]

    Java API for `akka.pattern.ask`: Sends a message asynchronously and returns a java.util.concurrent.CompletionStage holding the eventual reply message; this means that the target akka.actor.ActorSelection needs to send the result to the sender reference provided.

    Java API for `akka.pattern.ask`: Sends a message asynchronously and returns a java.util.concurrent.CompletionStage holding the eventual reply message; this means that the target akka.actor.ActorSelection needs to send the result to the sender reference provided.

    The CompletionStage will be completed with an akka.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 for AskTimeoutException 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)));
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.19) Use Pattens.ask which accepts java.time.Duration instead.

  6. def ask(selection: ActorSelection, message: Any, timeout: Duration): CompletionStage[AnyRef]

    Java API for `akka.pattern.ask`: Sends a message asynchronously and returns a java.util.concurrent.CompletionStage holding the eventual reply message; this means that the target akka.actor.ActorSelection needs to send the result to the sender reference provided.

    Java API for `akka.pattern.ask`: Sends a message asynchronously and returns a java.util.concurrent.CompletionStage holding the eventual reply message; this means that the target akka.actor.ActorSelection needs to send the result to the sender reference provided.

    The CompletionStage will be completed with an akka.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 for AskTimeoutException 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)));
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.19) Use Patterns.ask instead.

  7. def ask(selection: ActorSelection, message: Any, timeout: Timeout): CompletionStage[AnyRef]

    Java API for `akka.pattern.ask`: Sends a message asynchronously and returns a java.util.concurrent.CompletionStage holding the eventual reply message; this means that the target akka.actor.ActorSelection needs to send the result to the sender reference provided.

    Java API for `akka.pattern.ask`: Sends a message asynchronously and returns a java.util.concurrent.CompletionStage holding the eventual reply message; this means that the target akka.actor.ActorSelection needs to send the result to the sender reference provided.

    The CompletionStage will be completed with an akka.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 for AskTimeoutException 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)));
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.15) Use the overloaded one which accepts java.time.Duration instead.

  8. def ask(actor: ActorRef, message: Any, timeoutMillis: Long): CompletionStage[AnyRef]

    Java API for `akka.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 `akka.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 akka.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 for AskTimeoutException 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)));
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.19) Use Pattens.ask which accepts java.time.Duration instead.

  9. def ask(actor: ActorRef, message: Any, timeout: Duration): CompletionStage[AnyRef]

    Java API for `akka.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 `akka.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 akka.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 for AskTimeoutException 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)));
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.19) Use Patterns.ask instead.

  10. def ask(actor: ActorRef, message: Any, timeout: Timeout): CompletionStage[AnyRef]

    Java API for `akka.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 `akka.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 akka.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 for AskTimeoutException 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)));
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.15) Use the overloaded one which accepts java.time.Duration instead.

  11. def askWithReplyTo(selection: ActorSelection, messageFactory: Function[ActorRef, Any], timeoutMillis: Long): 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,
      askSender -> new Request(askSender),
      timeout);
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.19) Use Pattens.askWithReplyTo which accepts java.time.Duration instead.

  12. def askWithReplyTo(actor: ActorRef, messageFactory: Function[ActorRef, Any], timeoutMillis: Long): 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 = PatternsCS.askWithReplyTo(
      worker,
      replyTo -> new Request(replyTo),
      timeout);
    actor

    the actor to be asked

    messageFactory

    function taking an actor ref to reply to and returning the message to be sent

    timeoutMillis

    the timeout for the response before failing the returned completion operator

    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.19) Use Pattens.askWithReplyTo which accepts java.time.Duration instead.

  13. 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 = PatternsCS.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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.19) Use Pattens.askWithReplyTo instead.

  14. def askWithReplyTo(actor: ActorRef, messageFactory: Function[ActorRef, Any], timeout: Timeout): 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 = PatternsCS.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 operator

    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.15) Use the overloaded one which accepts java.time.Duration instead.

  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  16. 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 parameter

    If the target actor isn't terminated within the timeout the java.util.concurrent.CompletionStage is completed with failure akka.pattern.AskTimeoutException.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.19) Use Patterns.gracefulStop instead.

  17. def gracefulStop(target: ActorRef, timeout: FiniteDuration, 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 parameter

    If the target actor isn't terminated within the timeout the java.util.concurrent.CompletionStage is completed with failure akka.pattern.AskTimeoutException.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.12) Use the overloaded one which accepts java.time.Duration instead.

  18. 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 akka.pattern.AskTimeoutException.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.19) Use Patterns.gracefulStop instead.

  19. def gracefulStop(target: ActorRef, timeout: FiniteDuration): 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 akka.pattern.AskTimeoutException.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.12) Use the overloaded one which accepts java.time.Duration instead.

  20. def pipe[T](future: CompletionStage[T], context: ExecutionContext): pattern.PipeableCompletionStage[T]

    When this java.util.concurrent.CompletionStage finishes, send its result to the given akka.actor.ActorRef or akka.actor.ActorSelection.

    When this java.util.concurrent.CompletionStage finishes, send its result to the given akka.actor.ActorRef or akka.actor.ActorSelection. Returns the original CompletionStage to allow method chaining. If the future was completed with failure it is sent as a akka.actor.Status.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);
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.19) Use Patterns.pipe instead.

  21. 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).

    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.19) Use Patterns.retry instead.

Inherited from AnyRef

Inherited from Any

Ungrouped