Packages

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
ActorRefFactory, AnyRef, Any
Known Subclasses
ExtendedActorSystem
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ActorSystem
  2. ActorRefFactory
  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

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, an InvalidActorNameException is thrown.

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

    Definition Classes
    ActorRefFactory
    Exceptions thrown

    UnsupportedOperationException if invoked on an ActorSystem that uses a custom user guardian

    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

    UnsupportedOperationException if invoked on an ActorSystem that uses a custom user guardian

    akka.ConfigurationException if deployment, dispatcher or mailbox configuration is wrong

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

  6. 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
    ActorSystem → ActorRefFactory
  7. abstract def dispatchers: Dispatchers

    Helper object for looking up configured dispatchers.

  8. abstract def eventStream: EventStream

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

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

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

  11. abstract def log: LoggingAdapter

    Convenient logging adapter for logging to the ActorSystem#eventStream.

  12. abstract def logConfiguration(): Unit

    Log the configuration.

  13. abstract def mailboxes: Mailboxes

    Helper object for looking up configured mailbox types.

  14. abstract def name: String

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

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

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

    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.

    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.

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

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

    Register a block of code (callback) to run after ActorSystem.shutdown has been issued and all actors in this actor system have been stopped.

    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.

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

    Scala API

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

  19. abstract def settings: Settings

    The core settings extracted from the supplied configuration.

  20. abstract def stop(actor: ActorRef): Unit

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

    Stop the actor pointed to by the given akka.actor.ActorRef; this is an asynchronous operation, i.e. involves a message send. If this method is applied to the self reference from inside an Actor then that Actor is guaranteed to not process any further messages after this call; please note that the processing of the current message will continue, this method does not immediately terminate this actor.

    Definition Classes
    ActorRefFactory
  21. abstract def terminate(): Future[Terminated]

    Terminates this actor system.

    Terminates 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). Be careful to not schedule any operations on completion of the returned future using the dispatcher of this actor system as it will have been shut down before the future completes.

  22. abstract def whenTerminated: Future[Terminated]

    Returns a Future which will be completed after the ActorSystem has been terminated and termination hooks have been executed.

    Returns a Future which will be completed after the ActorSystem has been terminated and termination hooks have been executed. Be careful to not schedule any operations on the dispatcher of this actor system as it will have been shut down before this future completes.

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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.4) Use Await.result(whenTerminated, Duration.Inf) instead

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

    Throws TimeoutException in case of timeout.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.4) Use Await.result(whenTerminated, timeout) instead

  25. abstract def isTerminated: Boolean

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

    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.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.4) Use the whenTerminated method instead.

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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.4) Use the terminate() method instead

Concrete Value Members

  1. 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
  2. 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
  3. def child(child: String): ActorPath

    Java API: Create a new child actor path.

  4. def descendant(names: Iterable[String]): ActorPath

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

  5. val startTime: Long

    Start-up time in milliseconds since the epoch.

  6. def uptime: Long

    Up-time of this actor system in seconds.