akka.pattern.package.scala Maven / Gradle / Ivy
/**
* Copyright (C) 2009-2014 Typesafe Inc.
*/
package akka
import akka.actor._
/**
* == Commonly Used Patterns With Akka ==
*
* This package is used as a collection point for usage patterns which involve
* actors, futures, etc. but are loosely enough coupled to (multiple of) them
* to present them separately from the core implementation. Currently supported
* are:
*
*
* - ask: create a temporary one-off actor for receiving a reply to a
* message and complete a [[scala.concurrent.Future]] with it; returns said
* Future.
* - pipeTo: feed eventually computed value of a future to an [[akka.actor.ActorRef]] as
* a message.
* - pipeToSelection: feed eventually computed value of a future to an [[akka.actor.ActorSelection]] as
* a message.
*
*
* In Scala the recommended usage is to import the pattern from the package
* object:
* {{{
* import akka.pattern.ask
*
* ask(actor, message) // use it directly
* actor ask message // use it by implicit conversion
* }}}
*
* For Java the patterns are available as static methods of the [[akka.pattern.Patterns]]
* class:
* {{{
* import static akka.pattern.Patterns.ask;
*
* ask(actor, message);
* }}}
*/
package object pattern extends PipeToSupport with AskSupport with GracefulStopSupport with FutureTimeoutSupport {
}