trait ActorSystem[-T] extends ActorRef[T]
An ActorSystem is home to a hierarchy of Actors. It is created using
ActorSystem$ apply
from a Props object that describes the root
Actor of this hierarchy and which will create all other Actors beneath it.
A system also implements the ActorRef type, and sending a message to
the system directs that message to the root Actor.
- Self Type
- ActorSystem[T] with ActorRefImpl[T]
- Source
- ActorSystem.scala
- Alphabetic
- By Inheritance
- ActorSystem
- ActorRef
- Comparable
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
deadLetters[U]: ActorRef[U]
The deadLetter address is a destination that will accept (and discard) every message sent to it.
-
abstract
def
dispatchers: Dispatchers
Facilities for lookup up thread-pools from configuration.
-
abstract
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.
-
abstract
def
eventStream: EventStream
Main event bus of this actor system, used for example for logging.
-
implicit abstract
def
executionContext: ExecutionContextExecutor
The default thread pool of this ActorSystem, configured with settings in
akka.actor.default-dispatcher
. -
abstract
def
log: LoggingAdapter
A akka.event.LoggingAdapter that can be used to emit log messages without specifying a more detailed source.
A akka.event.LoggingAdapter that can be used to emit log messages without specifying a more detailed source. Typically it is desirable to construct a dedicated LoggingAdapter within each Actor from that Actor’s ActorRef in order to identify the log messages.
-
abstract
def
logConfiguration(): Unit
Log the configuration.
-
abstract
def
logFilter: LoggingFilter
A reference to this system’s logFilter, which filters usage of the #log akka.event.LoggingAdapter such that only permissible messages are sent via the #eventStream.
A reference to this system’s logFilter, which filters usage of the #log akka.event.LoggingAdapter such that only permissible messages are sent via the #eventStream. The default implementation will just test that the message is suitable for the current log level.
-
abstract
def
name: String
The name of this actor system, used to distinguish multiple ones within the same JVM & class loader.
-
abstract
def
printTree: String
Create a string representation of the actor hierarchy within this system.
Create a string representation of the actor hierarchy within this system.
The format of the string is subject to change, i.e. no stable “API”.
-
abstract
def
scheduler: Scheduler
A generic scheduler that can initiate the execution of tasks after some delay.
A generic scheduler that can initiate the execution of tasks after some delay. It is recommended to use the ActorContext’s scheduling capabilities for sending messages to actors instead of registering a Runnable for execution using this facility.
-
abstract
def
settings: Settings
The core settings extracted from the supplied configuration.
-
abstract
def
startTime: Long
Start-up time in milliseconds since the epoch.
-
abstract
def
systemActorOf[U](behavior: Behavior[U], name: String, deployment: DeploymentConfig = EmptyDeploymentConfig)(implicit timeout: Timeout): Future[ActorRef[U]]
Ask the system guardian of this system to create an actor from the given behavior and deployment and with the given name.
Ask the system guardian of this system to create an actor from the given behavior and deployment and with the given name. The name does not need to be unique since the guardian will prefix it with a running number when creating the child actor. The timeout sets the timeout used for the AskPattern$ invocation when asking the guardian.
The returned Future of ActorRef may be converted into an ActorRef to which messages can immediately be sent by using the ActorRef$apply method.
-
abstract
def
tell(msg: T): Unit
Send a message to the Actor referenced by this ActorRef using *at-most-once* messaging semantics.
Send a message to the Actor referenced by this ActorRef using *at-most-once* messaging semantics.
- Definition Classes
- ActorRef
-
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).
-
abstract
def
threadFactory: ThreadFactory
A ThreadFactory that can be used if the transport needs to create any Threads
-
abstract
def
uptime: Long
Up-time of this actor system in seconds.
-
abstract
def
whenTerminated: Future[Terminated]
Returns a Future which will be completed after the ActorSystem has been terminated and termination hooks have been executed.
Concrete Value Members
-
def
!(msg: T): Unit
Send a message to the Actor referenced by this ActorRef using *at-most-once* messaging semantics.
Send a message to the Actor referenced by this ActorRef using *at-most-once* messaging semantics.
- Definition Classes
- ActorRef
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from ActorSystem[T] to any2stringadd[ActorSystem[T]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (ActorSystem[T], B)
- Implicit
- This member is added by an implicit conversion from ActorSystem[T] to ArrowAssoc[ActorSystem[T]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
compareTo(other: ActorRef[Nothing]): Int
Comparison takes path and the unique id of the actor cell into account.
Comparison takes path and the unique id of the actor cell into account.
- Definition Classes
- ActorRef → Comparable
-
def
ensuring(cond: (ActorSystem[T]) ⇒ Boolean, msg: ⇒ Any): ActorSystem[T]
- Implicit
- This member is added by an implicit conversion from ActorSystem[T] to Ensuring[ActorSystem[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (ActorSystem[T]) ⇒ Boolean): ActorSystem[T]
- Implicit
- This member is added by an implicit conversion from ActorSystem[T] to Ensuring[ActorSystem[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): ActorSystem[T]
- Implicit
- This member is added by an implicit conversion from ActorSystem[T] to Ensuring[ActorSystem[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): ActorSystem[T]
- Implicit
- This member is added by an implicit conversion from ActorSystem[T] to Ensuring[ActorSystem[T]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
equals(that: Any): Boolean
Equals takes path and the unique id of the actor cell into account.
Equals takes path and the unique id of the actor cell into account.
- Definition Classes
- ActorRef → AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from ActorSystem[T] to StringFormat[ActorSystem[T]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
final
def
hashCode(): Int
- Definition Classes
- ActorRef → AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
final
val
path: ActorPath
The hierarchical path name of the referenced Actor.
The hierarchical path name of the referenced Actor. The lifecycle of the ActorRef is fully contained within the lifecycle of the akka.actor.ActorPath and more than one Actor instance can exist with the same path at different points in time, but not concurrently.
- Definition Classes
- ActorRef
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
toString(): String
- Definition Classes
- ActorRef → AnyRef → Any
-
def
upcast[U >: T]: ActorRef[U]
Unsafe utility method for widening the type accepted by this ActorRef; provided to avoid having to use
asInstanceOf
on the full reference type, which would unfortunately also work on non-ActorRefs.Unsafe utility method for widening the type accepted by this ActorRef; provided to avoid having to use
asInstanceOf
on the full reference type, which would unfortunately also work on non-ActorRefs.- Definition Classes
- ActorRef
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
→[B](y: B): (ActorSystem[T], B)
- Implicit
- This member is added by an implicit conversion from ActorSystem[T] to ArrowAssoc[ActorSystem[T]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc