Class

akka.actor

ExtendedActorSystem

Related Doc: package actor

Permalink

abstract class ExtendedActorSystem extends ActorSystem

More powerful interface to the actor system’s implementation which is presented to extensions (see akka.actor.Extension).

Important Notice:

This class is not meant to be extended by user code. If you want to actually roll your own Akka, beware that you are completely on your own in that case!

Source
ActorSystem.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ExtendedActorSystem
  2. ActorSystem
  3. ActorRefFactory
  4. AnyRef
  5. 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 ExtendedActorSystem()

    Permalink

Abstract Value Members

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

    Permalink

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

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

    Definition Classes
    ActorSystem
  2. abstract def /(name: String): ActorPath

    Permalink

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

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

    Definition Classes
    ActorSystem
  3. abstract def actorOf(props: Props, name: String): ActorRef

    Permalink

    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

    Permalink

    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

    Permalink

    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
    ActorSystem
  6. implicit abstract def dispatcher: ExecutionContextExecutor

    Permalink

    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
  7. abstract def dispatchers: Dispatchers

    Permalink

    Helper object for looking up configured dispatchers.

    Helper object for looking up configured dispatchers.

    Definition Classes
    ActorSystem
  8. abstract def dynamicAccess: DynamicAccess

    Permalink

    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.

  9. abstract def eventStream: EventStream

    Permalink

    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
    ActorSystem
  10. abstract def extension[T <: Extension](ext: ExtensionId[T]): T

    Permalink

    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
    ActorSystem
  11. abstract def guardian: InternalActorRef

    Permalink

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

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

    Definition Classes
    ExtendedActorSystemActorRefFactory
  12. abstract def hasExtension(ext: ExtensionId[_ <: Extension]): Boolean

    Permalink

    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
    ActorSystem
  13. abstract def log: LoggingAdapter

    Permalink

    Convenient logging adapter for logging to the ActorSystem#eventStream.

    Convenient logging adapter for logging to the ActorSystem#eventStream.

    Definition Classes
    ActorSystem
  14. abstract def logConfiguration(): Unit

    Permalink

    Log the configuration.

    Log the configuration.

    Definition Classes
    ActorSystem
  15. abstract def logFilter: LoggingFilter

    Permalink

    Filter of log events that is used by the LoggingAdapter before publishing log events to the eventStream

  16. abstract def lookupRoot: InternalActorRef

    Permalink

    INTERNAL API

    INTERNAL API

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

    Permalink

    Helper object for looking up configured mailbox types.

    Helper object for looking up configured mailbox types.

    Definition Classes
    ActorSystem
  18. abstract def name: String

    Permalink

    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
    ActorSystem
  19. abstract def provider: ActorRefProvider

    Permalink

    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
    ExtendedActorSystemActorRefFactory
  20. abstract def registerExtension[T <: Extension](ext: ExtensionId[T]): T

    Permalink

    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
    ActorSystem
  21. abstract def registerOnTermination(code: Runnable): Unit

    Permalink

    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.

    Definition Classes
    ActorSystem
  22. abstract def registerOnTermination[T](code: ⇒ T): Unit

    Permalink

    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

    Definition Classes
    ActorSystem
  23. abstract def scheduler: Scheduler

    Permalink

    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
    ActorSystem
  24. abstract def settings: Settings

    Permalink

    The core settings extracted from the supplied configuration.

    The core settings extracted from the supplied configuration.

    Definition Classes
    ActorSystem
  25. abstract def stop(actor: ActorRef): Unit

    Permalink

    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
  26. abstract def systemActorOf(props: Props, name: String): ActorRef

    Permalink

    Create an actor in the "/system" namespace.

    Create an actor in the "/system" namespace. This actor will be shut down during system.terminate only after all user actors have terminated.

  27. abstract def systemGuardian: InternalActorRef

    Permalink

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

  28. abstract def systemImpl: ActorSystemImpl

    Permalink

    INTERNAL API

    INTERNAL API

    Attributes
    protected
    Definition Classes
    ActorRefFactory
  29. abstract def terminate(): Future[Terminated]

    Permalink

    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.

    Definition Classes
    ActorSystem
  30. abstract def threadFactory: ThreadFactory

    Permalink

    A ThreadFactory that can be used if the transport needs to create any Threads

  31. abstract def whenTerminated: Future[Terminated]

    Permalink

    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.

    Definition Classes
    ActorSystem
  32. abstract def awaitTermination(): Unit

    Permalink

    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
    ActorSystem
    Annotations
    @deprecated
    Deprecated

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

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

    Permalink

    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.

    Definition Classes
    ActorSystem
    Annotations
    @deprecated
    Deprecated

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

  34. abstract def isTerminated: Boolean

    Permalink

    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.

    Definition Classes
    ActorSystem
    Annotations
    @deprecated
    Deprecated

    (Since version 2.4) Use the whenTerminated method instead.

  35. abstract def shutdown(): Unit

    Permalink

    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
    ActorSystem
    Annotations
    @deprecated
    Deprecated

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

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  6. def actorSelection(path: ActorPath): ActorSelection

    Permalink

    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
  7. def actorSelection(path: String): ActorSelection

    Permalink

    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
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def child(child: String): ActorPath

    Permalink

    Java API: Create a new child actor path.

    Java API: Create a new child actor path.

    Definition Classes
    ActorSystem
  10. def clone(): AnyRef

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

    Permalink

    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
  12. def ensuring(cond: (ExtendedActorSystem) ⇒ Boolean, msg: ⇒ Any): ExtendedActorSystem

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  26. val startTime: Long

    Permalink

    Start-up time in milliseconds since the epoch.

    Start-up time in milliseconds since the epoch.

    Definition Classes
    ActorSystem
  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  28. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  29. def uptime: Long

    Permalink

    Up-time of this actor system in seconds.

    Up-time of this actor system in seconds.

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. def [B](y: B): (ExtendedActorSystem, B)

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

Inherited from ActorSystem

Inherited from ActorRefFactory

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ExtendedActorSystem to any2stringadd[ExtendedActorSystem]

Inherited by implicit conversion StringFormat from ExtendedActorSystem to StringFormat[ExtendedActorSystem]

Inherited by implicit conversion Ensuring from ExtendedActorSystem to Ensuring[ExtendedActorSystem]

Inherited by implicit conversion ArrowAssoc from ExtendedActorSystem to ArrowAssoc[ExtendedActorSystem]

Ungrouped