akka.actor

ActorRefFactory

trait ActorRefFactory extends AnyRef

Interface implemented by ActorSystem and ActorContext, the only two places from which you can get fresh actors.

Annotations
@implicitNotFound( ... )
Source
ActorRefProvider.scala
Linear Supertypes
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ActorRefFactory
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract 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 akka.actor.Props for details on how to obtain a Props object.

    Exceptions thrown
    akka.ConfigurationException

    if deployment, dispatcher or mailbox configuration is wrong

    akka.actor.InvalidActorNameException

    if the given name is invalid or already in use

  2. abstract 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 akka.actor.Props for details on how to obtain a Props object.

    Exceptions thrown
    akka.ConfigurationException

    if deployment, dispatcher or mailbox configuration is wrong

  3. implicit abstract def dispatcher: ExecutionContextExecutor

    Returns the default MessageDispatcher associated with this ActorRefFactory

  4. abstract def guardian: InternalActorRef

    Father of all children created by this interface.

    Father of all children created by this interface.

    INTERNAL API

    Attributes
    protected
  5. abstract def lookupRoot: InternalActorRef

    INTERNAL API

    INTERNAL API

    Attributes
    protected
  6. abstract def provider: ActorRefProvider

    INTERNAL API

    INTERNAL API

    Attributes
    protected
  7. abstract def stop(actor: ActorRef): Unit

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

    Stop the actor pointed to by the given akka.actor.ActorRef; this is an asynchronous operation, i.e. involves a message send.

  8. abstract def systemImpl: ActorSystemImpl

    INTERNAL API

    INTERNAL API

    Attributes
    protected

Concrete Value Members

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

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

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

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from ActorRefFactory to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (ActorRefFactory, B)

    Implicit information
    This member is added by an implicit conversion from ActorRefFactory to ArrowAssoc[ActorRefFactory] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  8. def actorSelection(path: ActorPath): ActorSelection

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

    Construct an akka.actor.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.

  9. def actorSelection(path: String): ActorSelection

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

    Construct an akka.actor.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.

  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def ensuring(cond: (ActorRefFactory) ⇒ Boolean, msg: ⇒ Any): ActorRefFactory

    Implicit information
    This member is added by an implicit conversion from ActorRefFactory to Ensuring[ActorRefFactory] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (ActorRefFactory) ⇒ Boolean): ActorRefFactory

    Implicit information
    This member is added by an implicit conversion from ActorRefFactory to Ensuring[ActorRefFactory] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): ActorRefFactory

    Implicit information
    This member is added by an implicit conversion from ActorRefFactory to Ensuring[ActorRefFactory] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): ActorRefFactory

    Implicit information
    This member is added by an implicit conversion from ActorRefFactory to Ensuring[ActorRefFactory] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from ActorRefFactory to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int

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

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

    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

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

    Definition Classes
    AnyRef
  27. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. def [B](y: B): (ActorRefFactory, B)

    Implicit information
    This member is added by an implicit conversion from ActorRefFactory to ArrowAssoc[ActorRefFactory] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from ActorRefFactory to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (actorRefFactory: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from ActorRefFactory to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (actorRefFactory: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. 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 = getContext().actorFor(path);
      ...
    }
    }

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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use actorSelection instead of actorFor

  2. 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.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use actorSelection instead of actorFor

  3. 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 akka.actor.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])

    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use actorSelection instead of actorFor

  4. 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 akka.actor.ActorSystem.

    Look-up an actor by path; if it does not exist, returns a reference to the dead-letter mailbox of the akka.actor.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.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use actorSelection instead of actorFor

  5. def x: ActorRefFactory

    Implicit information
    This member is added by an implicit conversion from ActorRefFactory to ArrowAssoc[ActorRefFactory] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (actorRefFactory: ArrowAssoc[ActorRefFactory]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  6. def x: ActorRefFactory

    Implicit information
    This member is added by an implicit conversion from ActorRefFactory to Ensuring[ActorRefFactory] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (actorRefFactory: Ensuring[ActorRefFactory]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ActorRefFactory to StringAdd

Inherited by implicit conversion any2stringfmt from ActorRefFactory to StringFormat

Inherited by implicit conversion any2ArrowAssoc from ActorRefFactory to ArrowAssoc[ActorRefFactory]

Inherited by implicit conversion any2Ensuring from ActorRefFactory to Ensuring[ActorRefFactory]

Ungrouped