akka.actor

ActorContext

trait ActorContext extends ActorRefFactory

The actor context - the view of the actor cell from the actor. Exposes contextual information for the actor and the current message.

There are several possibilities for creating actors (see Props for details on props):

// Java or Scala
context.actorOf(props, "name")
context.actorOf(props)

// Scala
context.actorOf(Props[MyActor]("name")
context.actorOf(Props[MyActor]
context.actorOf(Props(new MyActor(...))

// Java
context.actorOf(classOf[MyActor]);
context.actorOf(Props(new Creator<MyActor>() {
  public MyActor create() { ... }
});
context.actorOf(Props(new Creator<MyActor>() {
  public MyActor create() { ... }
}, "name");

Where no name is given explicitly, one will be automatically generated.

Linear Supertypes
ActorRefFactory, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. ActorContext
  2. ActorRefFactory
  3. AnyRef
  4. Any
Visibility
  1. Public
  2. All

Abstract Value Members

  1. def actorOf (props: Props, name: String): ActorRef

    Create new actor as child of this context with the given name, which must not be null, empty or start with “$”.

    Create new actor as child of this context with the given name, which must not be null, empty or start with “$”. If the given name is already in use, and InvalidActorNameException is thrown.

    See Props for details on how to obtain a Props object.

    When invoked on ActorSystem, this method sends a message to the guardian actor and blocks waiting for a reply, see akka.actor.creation-timeout in the reference.conf.

    Attributes
    abstract
    Definition Classes
    ActorRefFactory
  2. def actorOf (props: Props): ActorRef

    Create new actor as child of this context and give it an automatically generated name (currently similar to base64-encoded integer count, reversed and with “$” prepended, may change in the future).

    Create new actor as child of this context and give it an automatically generated name (currently similar to base64-encoded integer count, reversed and with “$” prepended, may change in the future).

    See Props for details on how to obtain a Props object.

    When invoked on ActorSystem, this method sends a message to the guardian actor and blocks waiting for a reply, see akka.actor.creation-timeout in the reference.conf.

    Attributes
    abstract
    Definition Classes
    ActorRefFactory
  3. def become (behavior: Receive, discardOld: Boolean = true): Unit

    Changes the Actor's behavior to become the new 'Receive' (PartialFunction[Any, Unit]) handler.

    Changes the Actor's behavior to become the new 'Receive' (PartialFunction[Any, Unit]) handler. Puts the behavior on top of the hotswap stack. If "discardOld" is true, an unbecome will be issued prior to pushing the new behavior to the stack

    Attributes
    abstract
  4. def children : Iterable[ActorRef]

    Returns all supervised children; this method returns a view onto the internal collection of children.

    Returns all supervised children; this method returns a view onto the internal collection of children. Targeted lookups should be using actorFor instead for performance reasons:

    val badLookup = context.children find (_.path.name == "kid")
    // should better be expressed as:
    val goodLookup = context.actorFor("kid")
    
    Attributes
    abstract
  5. implicit def dispatcher : MessageDispatcher

    Returns the dispatcher (MessageDispatcher) that is used for this Actor.

    Returns the dispatcher (MessageDispatcher) that is used for this Actor. Importing this member will place a implicit MessageDispatcher in scope.

    Attributes
    implicit abstract
    Definition Classes
    ActorContextActorRefFactory
  6. def guardian : InternalActorRef

    Father of all children created by this interface.

    Father of all children created by this interface.

    Attributes
    protected abstract
    Definition Classes
    ActorRefFactory
  7. def lookupRoot : InternalActorRef

    Attributes
    protected abstract
    Definition Classes
    ActorRefFactory
  8. def parent : ActorRef

    Returns the supervising parent ActorRef.

    Returns the supervising parent ActorRef.

    Attributes
    abstract
  9. def props : Props

    Retrieve the Props which were used to create this actor.

    Retrieve the Props which were used to create this actor.

    Attributes
    abstract
  10. def provider : ActorRefProvider

    Attributes
    protected abstract
    Definition Classes
    ActorRefFactory
  11. def receiveTimeout : Option[Duration]

    Gets the current receive timeout When specified, the receive method should be able to handle a 'ReceiveTimeout' message.

    Gets the current receive timeout When specified, the receive method should be able to handle a 'ReceiveTimeout' message.

    Attributes
    abstract
  12. def resetReceiveTimeout (): Unit

    Clears the receive timeout, i.

    Clears the receive timeout, i.e. deactivates this feature.

    Attributes
    abstract
  13. def self : ActorRef

    Attributes
    abstract
  14. def sender : ActorRef

    Returns the sender 'ActorRef' of the current message.

    Returns the sender 'ActorRef' of the current message.

    Attributes
    abstract
  15. def setReceiveTimeout (timeout: Duration): Unit

    Defines the default timeout for an initial receive invocation.

    Defines the default timeout for an initial receive invocation. When specified, the receive function should be able to handle a 'ReceiveTimeout' message. 1 millisecond is the minimum supported timeout.

    Attributes
    abstract
  16. def stop (actor: ActorRef): Unit

    Stop the actor pointed to by the given ActorRef; this is an asynchronous operation, i.

    Stop the actor pointed to by the given ActorRef; this is an asynchronous operation, i.e. involves a message send, but if invoked on an ActorContext if operating on a child of that context it will free up the name for immediate reuse.

    When invoked on ActorSystem for a top-level actor, this method sends a message to the guardian actor and blocks waiting for a reply, see akka.actor.creation-timeout in the reference.conf.

    Attributes
    abstract
    Definition Classes
    ActorRefFactory
  17. implicit def system : ActorSystem

    The system that the actor belongs to.

    The system that the actor belongs to. Importing this member will place a implicit MessageDispatcher in scope.

    Attributes
    implicit abstract
  18. def systemImpl : ActorSystemImpl

    Attributes
    protected abstract
    Definition Classes
    ActorRefFactory
  19. def unbecome (): Unit

    Reverts the Actor behavior to the previous one in the hotswap stack.

    Reverts the Actor behavior to the previous one in the hotswap stack.

    Attributes
    abstract
  20. def unwatch (subject: ActorRef): ActorRef

    Unregisters this actor as Monitor for the provided ActorRef.

    Unregisters this actor as Monitor for the provided ActorRef.

    returns

    the provided ActorRef

    Attributes
    abstract
  21. def watch (subject: ActorRef): ActorRef

    Registers this actor as a Monitor for the provided ActorRef.

    Registers this actor as a Monitor for the provided ActorRef.

    returns

    the provided ActorRef

    Attributes
    abstract

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 actorFor (path: Iterable[String]): ActorRef

    Java API: Look-up an actor by applying the given path elements, starting from the current context, where ".." signifies the parent of an actor.

    Java API: Look-up an actor by applying the given path elements, starting from the current context, where ".." signifies the parent of an actor.

    Example:

    public class MyActor extends UntypedActor {
      public void onReceive(Object msg) throws Exception {
        ...
        final List<String> path = new ArrayList<String>();
        path.add("..");
        path.add("myBrother");
        path.add("myNephew");
        final ActorRef target = context().actorFor(path);
        ...
    }
    }
    

    For maximum performance use a collection with efficient head & tail operations.

    Definition Classes
    ActorRefFactory
  7. def actorFor (path: Iterable[String]): ActorRef

    Look-up an actor by applying the given path elements, starting from the current context, where ".." signifies the parent of an actor.

    Look-up an actor by applying the given path elements, starting from the current context, where ".." signifies the parent of an actor.

    Example:

    class MyActor extends Actor {
      def receive = {
        case msg =>
          ...
          val target = context.actorFor(Seq("..", "myBrother", "myNephew"))
          ...
    }
    }
    

    For maximum performance use a collection with efficient head & tail operations.

    Definition Classes
    ActorRefFactory
  8. def actorFor (path: String): ActorRef

    Look-up an actor by path represented as string.

    Look-up an actor by path represented as string.

    Absolute URIs like akka://appname/user/actorA are looked up as described for look-ups by actorOf(ActorPath).

    Relative URIs like /service/actorA/childB are looked up relative to the root path of the ActorSystem containing this factory and as described for look-ups by actorOf(Iterable[String]).

    Relative URIs like myChild/grandChild or ../myBrother are looked up relative to the current context as described for look-ups by actorOf(Iterable[String])

    Definition Classes
    ActorRefFactory
  9. def actorFor (path: ActorPath): ActorRef

    Look-up an actor by path; if it does not exist, returns a reference to the dead-letter mailbox of the ActorSystem.

    Look-up an actor by path; if it does not exist, returns a reference to the dead-letter mailbox of the ActorSystem. If the path point to an actor which is not local, no attempt is made during this call to verify that the actor it represents does exist or is alive; use watch(ref) to be notified of the target’s termination, which is also signaled if the queried path cannot be resolved.

    Definition Classes
    ActorRefFactory
  10. def actorSelection (path: String): ActorSelection

    Construct an ActorSelection from the given path, which is parsed for wildcards (these are replaced by regular expressions internally).

    Construct an ActorSelection from the given path, which is parsed for wildcards (these are replaced by regular expressions internally). No attempt is made to verify the existence of any part of the supplied path, it is recommended to send a message and gather the replies in order to resolve the matching set of actors.

    Definition Classes
    ActorRefFactory
  11. def asInstanceOf [T0] : T0

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

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  13. def eq (arg0: AnyRef): Boolean

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

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

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

    Attributes
    final
    Definition Classes
    AnyRef → Any
  17. def hashCode (): Int

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

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

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

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

    Attributes
    final
    Definition Classes
    AnyRef
  22. def synchronized [T0] (arg0: ⇒ T0): T0

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

    Definition Classes
    AnyRef → Any
  24. def wait (): Unit

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

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  27. def writeObject (o: ObjectOutputStream): Unit

    Attributes
    protected final

Inherited from ActorRefFactory

Inherited from AnyRef

Inherited from Any