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

5.  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.

6.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

7.  def ask(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.ask(
     selection,
     new akka.japi.Function<ActorRef, Object> {
       Object apply(ActorRef askSender) {
         return new Request(askSender);
       }
     },
     timeout);

8.  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)).

   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, timeout);
   f.onSuccess(new Procedure<Object>() {
     public void apply(Object o) {
       nextActor.tell(new EnrichedResult(request, o));
     }
   });

9.  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)).

   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, timeout);
   f.onSuccess(new Procedure<Object>() {
     public void apply(Object o) {
       nextActor.tell(new EnrichedResult(request, o));
     }
   });

10.  def ask(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 = Patterns.ask(
      worker,
      new akka.japi.Function<ActorRef, Object> {
        Object apply(ActorRef askSender) {
          return new Request(askSender);
        }
      },
      timeout);

11.  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)).

    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, timeout);
    f.onSuccess(new Procedure<Object>() {
      public void apply(Object o) {
        nextActor.tell(new EnrichedResult(request, o));
      }
    });

12.  def ask(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 = Patterns.ask(
      worker,
      new akka.japi.Function<ActorRef, Object> {
        Object apply(ActorRef askSender) {
          return new Request(askSender);
        }
      },
      timeout);

13.  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)).

    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, timeout);
    f.onSuccess(new Procedure<Object>() {
      public void apply(Object o) {
        nextActor.tell(new EnrichedResult(request, o));
      }
    });

14.  def clone(): AnyRef

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

15.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

16.  def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

17.  def finalize(): Unit

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

18.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

19.  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.

20.  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.

21.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

22.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

23.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

24.  final def notify(): Unit

    Definition Classes

    AnyRef

25.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

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

    Register an onComplete callback on this java.util.concurrent.CompletionStage to send the result to the given akka.actor.ActorRef or akka.actor.ActorSelection.

    Register an onComplete callback on this java.util.concurrent.CompletionStage to send the 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 = Patterns.ask(worker, request, timeout);
    // apply some transformation (i.e. enrich with request info)
    final CompletionStage<Object> transformed = f.map(new akka.japi.Function<Object, Object>() { ... });
    // send it on to the next stage
    Patterns.pipe(transformed).to(nextActor);

27.  final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes

    AnyRef

28.  def toString(): String

    Definition Classes

    AnyRef → Any

29.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

30.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

31.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )