Packages

trait Act extends Actor

This trait provides a DSL for writing the inner workings of an actor, e.g. for quickly trying things out in the REPL. It makes the following keywords available:

  • become mapped to context.become(_, discardOld = true)
  • becomeStacked mapped to context.become(_, discardOld = false)
  • unbecome mapped to context.unbecome
  • setup for implementing preStart()
  • whenFailing for implementing preRestart()
  • whenRestarted for implementing postRestart()
  • teardown for implementing postStop

Using the life-cycle keywords multiple times results in replacing the content of the respective hook.

Source
Creators.scala
Linear Supertypes
Actor, AnyRef, Any
Known Subclasses
ActWithStash
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Act
  2. Actor
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Receive = PartialFunction[Any, Unit]
    Definition Classes
    Actor

Value Members

  1. def AllForOneStrategy: actor.AllForOneStrategy.type

    See also

    akka.actor.AllForOneStrategy

  2. def Escalate: SupervisorStrategy.Escalate.type

    See also

    akka.actor.SupervisorStrategy

  3. def OneForOneStrategy: actor.OneForOneStrategy.type

    See also

    akka.actor.OneForOneStrategy

  4. def Restart: SupervisorStrategy.Restart.type

    See also

    akka.actor.SupervisorStrategy

  5. def Resume: SupervisorStrategy.Resume.type

    See also

    akka.actor.SupervisorStrategy

  6. def Stop: SupervisorStrategy.Stop.type

    See also

    akka.actor.SupervisorStrategy

  7. def become(r: Receive): Unit

    Replace the behavior at the top of the behavior stack for this actor.

    Replace the behavior at the top of the behavior stack for this actor. The stack is cleared upon restart. Use unbecome() to pop an element off this stack or becomeStacked() to push a new element on top of it.

  8. def becomeStacked(r: Receive): Unit

    Add the given behavior on top of the behavior stack for this actor.

    Add the given behavior on top of the behavior stack for this actor. This stack is cleared upon restart. Use unbecome() to pop an element off this stack.

  9. implicit val context: ActorContext

    Scala API: Stores the context for this actor, including self, and sender.

    Scala API: Stores the context for this actor, including self, and sender. It is implicit to support operations such as forward.

    WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

    akka.actor.ActorContext is the Scala API. getContext returns a akka.actor.AbstractActor.ActorContext, which is the Java API of the actor context.

    Definition Classes
    Actor
  10. def postRestart(cause: Throwable): Unit

    User overridable callback: By default it calls preStart().

    User overridable callback: By default it calls preStart().

    Definition Classes
    Act → Actor
  11. def postStop(): Unit

    User overridable callback.

    User overridable callback.

    Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.

    Definition Classes
    Act → Actor
  12. def preRestart(cause: Throwable, msg: Option[Any]): Unit

    Scala API: User overridable callback: By default it disposes of all children and then calls postStop().

    Scala API: User overridable callback: By default it disposes of all children and then calls postStop().

    Definition Classes
    Act → Actor
  13. def preStart(): Unit

    User overridable callback.

    User overridable callback.

    Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.

    Definition Classes
    Act → Actor
  14. def receive: Receive

    Default behavior of the actor is empty, use become to change this.

    Default behavior of the actor is empty, use become to change this.

    Definition Classes
    Act → Actor
  15. implicit final val self: ActorRef

    The 'self' field holds the ActorRef for this actor.

    The 'self' field holds the ActorRef for this actor.

    Can be used to send messages to itself: 

    self ! message

    Definition Classes
    Actor
  16. final def sender(): ActorRef

    The reference sender Actor of the last received message.

    The reference sender Actor of the last received message. Is defined if the message was sent from another Actor, else deadLetters in akka.actor.ActorSystem.

    WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

    Definition Classes
    Actor
  17. def superviseWith(s: SupervisorStrategy): Unit

    Set the supervisor strategy of this actor, i.e.

    Set the supervisor strategy of this actor, i.e. how it supervises its children.

  18. def supervisorStrategy: SupervisorStrategy

    User overridable definition the strategy to use for supervising child actors.

    User overridable definition the strategy to use for supervising child actors.

    Definition Classes
    Act → Actor
  19. def unbecome(): Unit

    Pop the active behavior from the behavior stack of this actor.

    Pop the active behavior from the behavior stack of this actor. This stack is cleared upon restart.

  20. def unhandled(message: Any): Unit

    User overridable callback.

    User overridable callback.

    Is called when a message isn't handled by the current behavior of the actor by default it fails with either a akka.actor.DeathPactException (in case of an unhandled akka.actor.Terminated message) or publishes an akka.actor.UnhandledMessage to the actor's system's akka.event.EventStream

    Definition Classes
    Actor
  21. def whenFailing(body: (Throwable, Option[Any]) ⇒ Unit): Unit

    Replace the preRestart action with the supplied function.

    Replace the preRestart action with the supplied function. Default action is to call super.preRestart(), which will kill all children and invoke postStop().

  22. def whenRestarted(body: (Throwable) ⇒ Unit): Unit

    Replace the postRestart action with the supplied function.

    Replace the postRestart action with the supplied function. Default action is to call super.postRestart which will call preStart().

  23. def whenStarting(body: ⇒ Unit): Unit

    Replace the preStart action with the supplied thunk.

    Replace the preStart action with the supplied thunk. Default action is to call super.preStart()

  24. def whenStopping(body: ⇒ Unit): Unit

    Replace the postStop action with the supplied thunk.

    Replace the postStop action with the supplied thunk. Default action is to call super.postStop.