object Patterns
- Source
- Patterns.scala
- Alphabetic
- By Inheritance
- Patterns
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
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: 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.
-
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, 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.ask( selection, new akka.japi.Function<ActorRef, Object> { Object apply(ActorRef askSender) { return new Request(askSender); } }, timeout);
-
def
ask(selection: ActorSelection, message: Any, timeoutMillis: Long): Future[AnyRef]
Java API for `akka.pattern.ask`: Sends a message asynchronously and returns a scala.concurrent.Future 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 scala.concurrent.Future holding the eventual reply message; this means that the target akka.actor.ActorSelection needs to send the result to the
sender
reference provided. The Future 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. inAwait.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 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: Timeout): Future[AnyRef]
Java API for `akka.pattern.ask`: Sends a message asynchronously and returns a scala.concurrent.Future 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 scala.concurrent.Future holding the eventual reply message; this means that the target akka.actor.ActorSelection needs to send the result to the
sender
reference provided. The Future 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. inAwait.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 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, 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.ask( worker, new akka.japi.Function<ActorRef, Object> { Object apply(ActorRef askSender) { return new Request(askSender); } }, timeout);
-
def
ask(actor: ActorRef, message: Any, timeoutMillis: Long): Future[AnyRef]
Java API for `akka.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 `akka.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 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. inAwait.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 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, 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.ask( worker, new akka.japi.Function<ActorRef, Object> { Object apply(ActorRef askSender) { return new Request(askSender); } }, timeout);
-
def
ask(actor: ActorRef, message: Any, timeout: Timeout): Future[AnyRef]
Java API for `akka.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 `akka.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 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. inAwait.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 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
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
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 akka.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 akka.pattern.AskTimeoutException.
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
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 akka.actor.ActorRef or akka.actor.ActorSelection.
Register an onComplete callback on this scala.concurrent.Future to send the result to the given akka.actor.ActorRef or akka.actor.ActorSelection. Returns the original Future 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 Future<Object> f = Patterns.ask(worker, request, timeout); // apply some transformation (i.e. enrich with request info) final Future<Object> transformed = f.map(new akka.japi.Function<Object, Object>() { ... }); // send it on to the next stage Patterns.pipe(transformed).to(nextActor);
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )