akka.actor

UntypedActor

class UntypedActor extends Actor

Actor base trait that should be extended by or mixed to create an Actor with the semantics of the 'Actor Model': http://en.wikipedia.org/wiki/Actor_model

This class is the Java cousin to the Actor Scala interface. Subclass this abstract class to create a MDB-style untyped actor.

An actor has a well-defined (non-cyclic) life-cycle.

The Actor's own ActorRef is available as getSelf(), the current message’s sender as getSender() and the UntypedActorContext as getContext(). The only abstract method is onReceive() which is invoked for each processed message unless dynamically overridden using getContext().become().

Here is an example on how to create and use an UntypedActor:

 public class SampleUntypedActor extends UntypedActor {

   public class Reply {
     final public ActorRef sender;
     final public Result result;
     Reply(ActorRef sender, Result result) {
       this.sender = sender;
       this.result = result;
     }
   }

  private static SupervisorStrategy strategy = new OneForOneStrategy(10, Duration.parse("1 minute"),
    new Function<Throwable, Directive>() {
      @Override
      public Directive apply(Throwable t) {
        if (t instanceof ArithmeticException) {
          return resume();
        } else if (t instanceof NullPointerException) {
          return restart();
        } else if (t instanceof IllegalArgumentException) {
          return stop();
        } else {
          return escalate();
        }
      }
    });

  @Override
  public SupervisorStrategy supervisorStrategy() {
    return strategy;
   }

   public void onReceive(Object message) throws Exception {
     if (message instanceof String) {
       String msg = (String)message;

       if (msg.equals("UseSender")) {
         // Reply to original sender of message
         getSender().tell(msg + ":" + getSelf());

       } else if (msg.equals("SendToSelf")) {
         // Send message to the actor itself recursively
         getSelf().tell("SomeOtherMessage");

       } else if (msg.equals("ErrorKernelWithDirectReply")) {
         // Send work to one-off child which will reply directly to original sender
         getContext().actorOf(new Props(Worker.class)).tell("DoSomeDangerousWork", getSender());

       } else if (msg.equals("ErrorKernelWithReplyHere")) {
         // Send work to one-off child and collect the answer, reply handled further down
         getContext().actorOf(new Props(Worker.class)).tell("DoWorkAndReplyToMe");

       } else throw new IllegalArgumentException("Unknown message: " + message);

     } else if (message instanceof Reply) {

       final Reply reply = (Reply) message;
       // might want to do some processing/book-keeping here
       reply.sender.tell(reply.result);

     } else throw new IllegalArgumentException("Unknown message: " + message);
   }
 }
Attributes
abstract
Linear Supertypes
Actor, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. UntypedActor
  2. Actor
  3. AnyRef
  4. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new UntypedActor ()

Type Members

  1. type Receive = PartialFunction[Any, Unit]

    Definition Classes
    Actor

Abstract Value Members

  1. def onReceive (message: Any): Unit

    To be implemented by concrete UntypedActor.

    To be implemented by concrete UntypedActor. Defines the message handler.

    Attributes
    abstract
    Annotations
    @throws( classOf[Exception] )

Concrete Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any
  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  6. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any
  7. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  8. implicit val context : ActorContext

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

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

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

    Attributes
    protected[akka] implicit
    Definition Classes
    Actor
  9. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  10. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  11. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  12. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any
  13. def getContext (): UntypedActorContext

  14. def getSelf (): ActorRef

    Returns the 'self' reference.

  15. def getSender (): ActorRef

    The reference sender Actor of the currently processed message.

    The reference sender Actor of the currently processed message. This is always a legal destination to send to, even if there is no logical recipient for the reply, in which case it will be sent to the dead letter mailbox.

  16. def hashCode (): Int

    Definition Classes
    AnyRef → Any
  17. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any
  18. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  19. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  20. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  21. def postRestart (reason: Throwable): Unit

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

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

    Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash.

    Definition Classes
    UntypedActorActor
  22. def postStop (): Unit

    User overridable callback.

    User overridable callback.

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

    Definition Classes
    UntypedActorActor
  23. def preRestart (reason: Throwable, message: Option[Any]): Unit

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

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

    Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated.

    Definition Classes
    UntypedActorActor
  24. def preStart (): Unit

    User overridable callback.

    User overridable callback.

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

    Definition Classes
    UntypedActorActor
  25. def receive : PartialFunction[Any, Unit]

    This defines the initial actor behavior, it must return a partial function with the actor logic.

    This defines the initial actor behavior, it must return a partial function with the actor logic.

    Attributes
    protected final
    Definition Classes
    UntypedActorActor
  26. implicit 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
    

    Attributes
    implicit final
    Definition Classes
    Actor
  27. 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 ActorSystem.

    Attributes
    final
    Definition Classes
    Actor
  28. 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
    UntypedActorActor
  29. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  30. def toString (): String

    Definition Classes
    AnyRef → Any
  31. 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 DeathPactException (in case of an unhandled Terminated message) or publishes an UnhandledMessage to the actor's system's EventStream

    Definition Classes
    Actor
  32. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  33. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  34. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from Actor

Inherited from AnyRef

Inherited from Any