akka.actor

ActorSystem

abstract class ActorSystem extends ActorRefFactory

An actor system is a hierarchical group of actors which share common configuration, e.g. dispatchers, deployments, remote capabilities and addresses. It is also the entry point for creating or looking up actors.

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

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

// Scala
system.actorOf(Props[MyActor], "name")
system.actorOf(Props(classOf[MyActor], arg1, arg2), "name")

// Java
system.actorOf(Props.create(MyActor.class), "name");
system.actorOf(Props.create(MyActor.class, arg1, arg2), "name");

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

Important Notice:

This class is not meant to be extended by user code. If you want to actually roll your own Akka, it will probably be better to look into extending akka.actor.ExtendedActorSystem instead, but beware that you are completely on your own in that case!

Source
ActorSystem.scala
Linear Supertypes
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ActorSystem
  2. ActorRefFactory
  3. AnyRef
  4. 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

Instance Constructors

  1. new ActorSystem()

Abstract Value Members

  1. abstract def /(name: Iterable[String]): ActorPath

    Construct a path below the application guardian to be used with ActorSystem.actorSelection.

  2. abstract def /(name: String): ActorPath

    Construct a path below the application guardian to be used with ActorSystem.actorSelection.

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

    Definition Classes
    ActorRefFactory
    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

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

    Definition Classes
    ActorRefFactory
    Exceptions thrown
    akka.ConfigurationException

    if deployment, dispatcher or mailbox configuration is wrong

  5. abstract def awaitTermination(): Unit

    Block current thread until the system has been shutdown.

    Block current thread until the system has been shutdown. This will block until after all on termination callbacks have been run.

  6. abstract def awaitTermination(timeout: Duration): Unit

    Block current thread until the system has been shutdown, or the specified timeout has elapsed.

    Block current thread until the system has been shutdown, or the specified timeout has elapsed. This will block until after all on termination callbacks have been run.

    Exceptions thrown
    TimeoutException

    in case of timeout

  7. abstract def deadLetters: ActorRef

    Actor reference where messages are re-routed to which were addressed to stopped or non-existing actors.

    Actor reference where messages are re-routed to which were addressed to stopped or non-existing actors. Delivery to this actor is done on a best effort basis and hence not strictly guaranteed.

  8. implicit abstract def dispatcher: ExecutionContextExecutor

    Default dispatcher as configured.

    Default dispatcher as configured. This dispatcher is used for all actors in the actor system which do not have a different dispatcher configured explicitly. Importing this member will place the default MessageDispatcher in scope.

    Definition Classes
    ActorSystemActorRefFactory
  9. abstract def dispatchers: Dispatchers

    Helper object for looking up configured dispatchers.

  10. abstract def eventStream: EventStream

    Main event bus of this actor system, used for example for logging.

  11. abstract def extension[T <: Extension](ext: ExtensionId[T]): T

    Returns the payload that is associated with the provided extension throws an IllegalStateException if it is not registered.

    Returns the payload that is associated with the provided extension throws an IllegalStateException if it is not registered. This method can potentially block, waiting for the initialization of the payload, if is in the process of registration from another Thread of execution

  12. abstract def guardian: InternalActorRef

    Father of all children created by this interface.

    Father of all children created by this interface.

    INTERNAL API

    Attributes
    protected
    Definition Classes
    ActorRefFactory
  13. abstract def hasExtension(ext: ExtensionId[_ <: Extension]): Boolean

    Returns whether the specified extension is already registered, this method can potentially block, waiting for the initialization of the payload, if is in the process of registration from another Thread of execution

  14. abstract def isTerminated: Boolean

    Query the termination status: if it returns true, all callbacks have run and the ActorSystem has been fully stopped, i.

    Query the termination status: if it returns true, all callbacks have run and the ActorSystem has been fully stopped, i.e. awaitTermination(0 seconds) would return normally. If this method returns false, the status is actually unknown, since it might have changed since you queried it.

  15. abstract def log: LoggingAdapter

    Convenient logging adapter for logging to the ActorSystem.eventStream.

  16. abstract def logConfiguration(): Unit

    Log the configuration.

  17. abstract def lookupRoot: InternalActorRef

    INTERNAL API

    INTERNAL API

    Attributes
    protected
    Definition Classes
    ActorRefFactory
  18. abstract def mailboxes: Mailboxes

    Helper object for looking up configured mailbox types.

  19. abstract def name: String

    The name of this actor system, used to distinguish multiple ones within the same JVM & class loader.

  20. abstract def provider: ActorRefProvider

    INTERNAL API

    INTERNAL API

    Attributes
    protected
    Definition Classes
    ActorRefFactory
  21. abstract def registerExtension[T <: Extension](ext: ExtensionId[T]): T

    Registers the provided extension and creates its payload, if this extension isn't already registered This method has putIfAbsent-semantics, this method can potentially block, waiting for the initialization of the payload, if is in the process of registration from another Thread of execution

  22. abstract def registerOnTermination(code: Runnable): Unit

    Java API: Register a block of code (callback) to run after ActorSystem.

    Java API: Register a block of code (callback) to run after ActorSystem.shutdown has been issued and all actors in this actor system have been stopped. Multiple code blocks may be registered by calling this method multiple times. The callbacks will be run sequentially in reverse order of registration, i.e. last registration is run first.

    Exceptions thrown
    a

    RejectedExecutionException if the System has already shut down or if shutdown has been initiated.

  23. abstract def registerOnTermination[T](code: ⇒ T): Unit

    Register a block of code (callback) to run after ActorSystem.

    Register a block of code (callback) to run after ActorSystem.shutdown has been issued and all actors in this actor system have been stopped. Multiple code blocks may be registered by calling this method multiple times. The callbacks will be run sequentially in reverse order of registration, i.e. last registration is run first.

    Exceptions thrown
    a

    RejectedExecutionException if the System has already shut down or if shutdown has been initiated.

    Scala API

  24. abstract def scheduler: Scheduler

    Light-weight scheduler for running asynchronous tasks after some deadline in the future.

    Light-weight scheduler for running asynchronous tasks after some deadline in the future. Not terribly precise but cheap.

  25. abstract def settings: Settings

    The core settings extracted from the supplied configuration.

  26. abstract def shutdown(): Unit

    Stop this actor system.

    Stop this actor system. This will stop the guardian actor, which in turn will recursively stop all its child actors, then the system guardian (below which the logging actors reside) and the execute all registered termination handlers (see ActorSystem.registerOnTermination).

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

    Definition Classes
    ActorRefFactory
  28. abstract def systemImpl: ActorSystemImpl

    INTERNAL API

    INTERNAL API

    Attributes
    protected
    Definition Classes
    ActorRefFactory

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 ActorSystem to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (ActorSystem, B)

    Implicit information
    This member is added by an implicit conversion from ActorSystem to ArrowAssoc[ActorSystem] 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.

    Definition Classes
    ActorRefFactory
  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.

    Definition Classes
    ActorRefFactory
  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. def child(child: String): ActorPath

    Java API: Create a new child actor path.

  12. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. def descendant(names: Iterable[String]): ActorPath

    Java API: Recursively create a descendant’s path by appending all child names.

  14. def ensuring(cond: (ActorSystem) ⇒ Boolean, msg: ⇒ Any): ActorSystem

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

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

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

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    AnyRef
  28. val startTime: Long

    Start-up time in milliseconds since the epoch.

  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  30. def toString(): String

    Definition Classes
    AnyRef → Any
  31. def uptime: Long

    Up-time of this actor system in seconds.

  32. final def wait(): Unit

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

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

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

    Implicit information
    This member is added by an implicit conversion from ActorSystem to ArrowAssoc[ActorSystem] 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 ActorSystem 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:
    (actorSystem: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from ActorSystem 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:
    (actorSystem: 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.

    Definition Classes
    ActorRefFactory
    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.

    Definition Classes
    ActorRefFactory
    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])

    Definition Classes
    ActorRefFactory
    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.

    Definition Classes
    ActorRefFactory
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use actorSelection instead of actorFor

  5. def x: ActorSystem

    Implicit information
    This member is added by an implicit conversion from ActorSystem to ArrowAssoc[ActorSystem] 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:
    (actorSystem: ArrowAssoc[ActorSystem]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  6. def x: ActorSystem

    Implicit information
    This member is added by an implicit conversion from ActorSystem to Ensuring[ActorSystem] 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:
    (actorSystem: Ensuring[ActorSystem]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from ActorRefFactory

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ActorSystem to StringAdd

Inherited by implicit conversion any2stringfmt from ActorSystem to StringFormat

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

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

Ungrouped