akka.actor

GlobalActorSystem

object GlobalActorSystem extends ActorSystemImpl

Annotations
@deprecated
Deprecated

(Since version 2.0) use ActorSystem instead

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. GlobalActorSystem
  2. ActorSystemImpl
  3. ExtendedActorSystem
  4. ActorSystem
  5. ActorRefFactory
  6. AnyRef
  7. Any
Visibility
  1. Public
  2. All

Type Members

  1. final class TerminationCallbacks extends Runnable with Awaitable[Unit]

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

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

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

    Definition Classes
    ActorSystemImplActorSystem
  5. def /(actorName: String): ActorPath

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

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

    Definition Classes
    ActorSystemImplActorSystem
  6. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  8. val AwaitTimeout: Timeout

    Timeout used in OldFuture.get and default implicit ask timeout.

    Timeout used in OldFuture.get and default implicit ask timeout. Hard coded since the migration kit is not intended to be used for production anyway.

  9. 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
  10. 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
  11. 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
  12. 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
  13. 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.

    Definition Classes
    ActorSystemImplActorRefFactory
  14. 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.

    Definition Classes
    ActorSystemImplActorRefFactory
  15. 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
  16. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  17. 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.

    Definition Classes
    ActorSystemImplActorSystem
  18. 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.

    Definition Classes
    ActorSystemImplActorSystem
    Exceptions thrown
    TimeoutException

    in case of timeout

  19. def child(child: String): ActorPath

    Java API: Create a new child actor path.

    Java API: Create a new child actor path.

    Definition Classes
    ActorSystem
  20. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  21. def createDynamicAccess(): DynamicAccess

    This is an extension point: by overriding this method, subclasses can control all reflection activities of an actor system.

    This is an extension point: by overriding this method, subclasses can control all reflection activities of an actor system.

    Attributes
    protected
    Definition Classes
    ActorSystemImpl
  22. def createScheduler(): Scheduler

    Create the scheduler service.

    Create the scheduler service. This one needs one special behavior: if Closeable, it MUST execute all outstanding tasks upon .close() in order to properly shutdown all dispatchers.

    Furthermore, this timer service MUST throw IllegalStateException if it cannot schedule a task. Once scheduled, the task MUST be executed. If executed upon close(), the task may execute before its timeout.

    Attributes
    protected
    Definition Classes
    ActorSystemImpl
  23. val deadLetterMailbox: Mailbox

    Definition Classes
    ActorSystemImpl
  24. val deadLetterQueue: MessageQueue

    Definition Classes
    ActorSystemImpl
  25. 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.

    Definition Classes
    ActorSystemImplActorSystem
  26. def deathWatch: DeathWatch

    Implementation of the mechanism which is used for watch()/unwatch().

    Implementation of the mechanism which is used for watch()/unwatch().

    Definition Classes
    ActorSystemImplExtendedActorSystem
  27. def descendant(names: Iterable[String]): ActorPath

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

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

    Definition Classes
    ActorSystem
  28. val dispatcher: MessageDispatcher

    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.

    Definition Classes
    ActorSystemImplActorSystemActorRefFactory
  29. val dispatchers: Dispatchers

    Helper object for looking up configured dispatchers.

    Helper object for looking up configured dispatchers.

    Definition Classes
    ActorSystemImplActorSystem
  30. def dynamicAccess: DynamicAccess

    ClassLoader wrapper which is used for reflective accesses internally.

    ClassLoader wrapper which is used for reflective accesses internally. This is set to use the context class loader, if one is set, or the class loader which loaded the ActorSystem implementation. The context class loader is also set on all threads created by the ActorSystem, if one was set during creation.

    Definition Classes
    ActorSystemImplExtendedActorSystem
  31. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  33. val eventStream: EventStream

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

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

    Definition Classes
    ActorSystemImplActorSystem
  34. 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

    Definition Classes
    ActorSystemImplActorSystem
  35. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  37. def guardian: InternalActorRef

    The top-level supervisor of all actors created using system.

    The top-level supervisor of all actors created using system.actorOf(...).

    Definition Classes
    ActorSystemImplExtendedActorSystemActorRefFactory
  38. def hasExtension(ext: akka.actor.ExtensionId[_ <: akka.actor.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

    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

    Definition Classes
    ActorSystemImplActorSystem
  39. def hashCode(): Int

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

    Definition Classes
    Any
  41. 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.

    Definition Classes
    ActorSystemImplActorSystem
  42. val log: LoggingAdapter

    Convenient logging adapter for logging to the ActorSystem.eventStream.

    Convenient logging adapter for logging to the ActorSystem.eventStream.

    Definition Classes
    ActorSystemImplActorSystem
  43. def logConfiguration(): Unit

    Log the configuration.

    Log the configuration.

    Definition Classes
    ActorSystemImplActorSystem
  44. def lookupRoot: InternalActorRef

    Definition Classes
    ActorSystemImplActorRefFactory
  45. val name: String

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

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

    Definition Classes
    ActorSystemImplActorSystem
  46. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  49. val provider: ActorRefProvider

    The ActorRefProvider is the only entity which creates all actor references within this actor system.

    The ActorRefProvider is the only entity which creates all actor references within this actor system.

    Definition Classes
    ActorSystemImplExtendedActorSystemActorRefFactory
  50. final 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

    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

    Definition Classes
    ActorSystemImplActorSystem
    Annotations
    @tailrec()
  51. def registerOnTermination(code: Runnable): Unit

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

    Register a block of code (callback) to run after 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.

    Definition Classes
    ActorSystemImplActorSystem
    Exceptions thrown
    a

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

    Java API

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

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

    Register a block of code (callback) to run after 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.

    Definition Classes
    ActorSystemImplActorSystem
    Exceptions thrown
    a

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

    Scala API

  53. val 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.

    Definition Classes
    ActorSystemImplActorSystem
  54. final val settings: Settings

    The core settings extracted from the supplied configuration.

    The core settings extracted from the supplied configuration.

    Definition Classes
    ActorSystemImplActorSystem
  55. 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).

    Definition Classes
    ActorSystemImplActorSystem
  56. def start(): akka.actor.GlobalActorSystem.type

    Definition Classes
    ActorSystemImpl
  57. val startTime: Long

    Start-up time in milliseconds since the epoch.

    Start-up time in milliseconds since the epoch.

    Definition Classes
    ActorSystem
  58. 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. 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.

    Definition Classes
    ActorSystemImplActorRefFactory
  59. def stopScheduler(): Unit

    Attributes
    protected
    Definition Classes
    ActorSystemImpl
  60. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  61. def systemGuardian: InternalActorRef

    The top-level supervisor of all system-internal services like logging.

    The top-level supervisor of all system-internal services like logging.

    Definition Classes
    ActorSystemImplExtendedActorSystem
  62. def systemImpl: ActorSystemImpl

    Attributes
    protected
    Definition Classes
    ActorSystemImplActorRefFactory
  63. def terminationFuture: Future[Unit]

    Definition Classes
    ActorSystemImpl
  64. final val threadFactory: MonitorableThreadFactory

    Definition Classes
    ActorSystemImpl
  65. def toString(): String

    Definition Classes
    ActorSystemImpl → AnyRef → Any
  66. def uncaughtExceptionHandler: UncaughtExceptionHandler

    Attributes
    protected
    Definition Classes
    ActorSystemImpl
  67. def uptime: Long

    Up-time of this actor system in seconds.

    Up-time of this actor system in seconds.

    Definition Classes
    ActorSystem
  68. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from ActorSystemImpl

Inherited from ExtendedActorSystem

Inherited from ActorSystem

Inherited from ActorRefFactory

Inherited from AnyRef

Inherited from Any