Class ActorSystemStub
- java.lang.Object
-
- akka.actor.typed.ActorSystem<scala.runtime.Nothing$>
-
- akka.actor.testkit.typed.internal.ActorSystemStub
-
- All Implemented Interfaces:
ClassicActorSystemProvider
,ActorRef<scala.runtime.Nothing$>
,Extensions
,ActorRefImpl<scala.runtime.Nothing$>
,InternalRecipientRef<scala.runtime.Nothing$>
,RecipientRef<scala.runtime.Nothing$>
,java.io.Serializable
,java.lang.Comparable<ActorRef<?>>
public final class ActorSystemStub extends ActorSystem<scala.runtime.Nothing$> implements ActorRef<scala.runtime.Nothing$>, ActorRefImpl<scala.runtime.Nothing$>, InternalRecipientRef<scala.runtime.Nothing$>
INTERNAL API- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface akka.actor.typed.ActorRef
ActorRef.ActorRefOps<T>, ActorRef.ActorRefOps$
-
Nested classes/interfaces inherited from interface akka.actor.typed.RecipientRef
RecipientRef.RecipientRefOps<T>, RecipientRef.RecipientRefOps$
-
-
Constructor Summary
Constructors Constructor Description ActorSystemStub(java.lang.String name)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Address
address()
Obtains the external address of the default transport.scala.runtime.Nothing$
classicSystem()
ControlledExecutor
controlledExecutor()
<U> ActorRef<U>
deadLetters()
The deadLetter address is a destination that will accept (and discard) every message sent to it.DebugRef<java.lang.Object>
deadLettersInbox()
Dispatchers
dispatchers()
Facilities for lookup up thread-pools from configuration.DynamicAccess
dynamicAccess()
ClassLoader wrapper which is used for reflective accesses internally.scala.concurrent.ExecutionContextExecutor
executionContext()
The default thread pool of this ActorSystem, configured with settings inakka.actor.default-dispatcher
.<T extends Extension>
Textension(ExtensionId<T> ext)
Returns the payload that is associated with the provided extension throws an IllegalStateException if it is not registered.java.util.concurrent.CompletionStage<Done>
getWhenTerminated()
Java API: Returns a CompletionStage which will be completed after the ActorSystem has been terminated and termination hooks have been executed.boolean
hasExtension(ExtensionId<? extends Extension> ext)
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 executionboolean
isLocal()
boolean
isTerminated()
org.slf4j.Logger
log()
ALogger
that can be used to emit log messages without specifying a more detailed source.void
logConfiguration()
Log the configuration.java.lang.String
name()
ActorPath
path()
The hierarchical path name of the referenced Actor.java.lang.String
printTree()
Create a string representation of the actor hierarchy within this system for debugging purposes.ActorRefProvider
provider()
Get a reference to the actor ref provider which created this ref.<T extends Extension>
TregisterExtension(ExtensionId<T> ext)
Scheduler
scheduler()
A generic scheduler that can initiate the execution of tasks after some delay.void
sendSystem(SystemMessage signal)
Settings
settings()
The core settings extracted from the supplied configuration.long
startTime()
Start-up time in milliseconds since the epoch.<U> ActorRef<U>
systemActorOf(Behavior<U> behavior, java.lang.String name, Props props)
Create an actor in the "/system" namespace.void
tell(scala.runtime.Nothing$ message)
Send a message to the Actor referenced by this ActorRef using *at-most-once* messaging semantics.void
terminate()
Terminates this actor system by runningCoordinatedShutdown
with reasonakka.actor.CoordinatedShutdown.ActorSystemTerminateReason
.java.util.concurrent.ThreadFactory
threadFactory()
A ThreadFactory that can be used if the transport needs to create any Threadslong
uptime()
Up-time of this actor system in seconds.scala.concurrent.Future<Done>
whenTerminated()
Scala API: Returns a Future which will be completed after the ActorSystem has been terminated and termination hooks have been executed.-
Methods inherited from class akka.actor.typed.ActorSystem
apply, apply, apply, apply, apply, apply$default$4, create, create, create, create, create, eventStream, receptionist, systemActorOf$default$3, wrap
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface akka.actor.typed.ActorRef
writeReplace
-
Methods inherited from interface akka.actor.typed.internal.ActorRefImpl
compareTo, equals, hashCode, narrow, toString, unsafeUpcast
-
-
-
-
Method Detail
-
address
public Address address()
Description copied from class:ActorSystem
Obtains the external address of the default transport.Consider differences in clustered and non-clustered ActorSystems. For a non-clustered ActorSystem, this will return an address without host and port. For a clustered ActorSystem, this will return the address that other nodes can use to communicate with this node.
- Specified by:
address
in classActorSystem<scala.runtime.Nothing$>
- Returns:
- (undocumented)
-
classicSystem
public scala.runtime.Nothing$ classicSystem()
- Specified by:
classicSystem
in interfaceClassicActorSystemProvider
-
controlledExecutor
public ControlledExecutor controlledExecutor()
-
deadLetters
public <U> ActorRef<U> deadLetters()
Description copied from class:ActorSystem
The deadLetter address is a destination that will accept (and discard) every message sent to it.- Specified by:
deadLetters
in classActorSystem<scala.runtime.Nothing$>
- Returns:
- (undocumented)
-
deadLettersInbox
public DebugRef<java.lang.Object> deadLettersInbox()
-
dispatchers
public Dispatchers dispatchers()
Description copied from class:ActorSystem
Facilities for lookup up thread-pools from configuration.- Specified by:
dispatchers
in classActorSystem<scala.runtime.Nothing$>
- Returns:
- (undocumented)
-
dynamicAccess
public DynamicAccess dynamicAccess()
Description copied from class:ActorSystem
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.- Specified by:
dynamicAccess
in classActorSystem<scala.runtime.Nothing$>
- Returns:
- (undocumented)
-
executionContext
public scala.concurrent.ExecutionContextExecutor executionContext()
Description copied from class:ActorSystem
The default thread pool of this ActorSystem, configured with settings inakka.actor.default-dispatcher
.- Specified by:
executionContext
in classActorSystem<scala.runtime.Nothing$>
- Returns:
- (undocumented)
-
extension
public <T extends Extension> T extension(ExtensionId<T> ext)
Description copied from interface:Extensions
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- Specified by:
extension
in interfaceExtensions
- Parameters:
ext
- (undocumented)- Returns:
- (undocumented)
-
getWhenTerminated
public java.util.concurrent.CompletionStage<Done> getWhenTerminated()
Description copied from class:ActorSystem
Java API: Returns a CompletionStage which will be completed after the ActorSystem has been terminated and termination hooks have been executed. TheActorSystem
can be stopped withActorSystem.terminate
or by stopping the guardian actor.- Specified by:
getWhenTerminated
in classActorSystem<scala.runtime.Nothing$>
- Returns:
- (undocumented)
-
hasExtension
public boolean hasExtension(ExtensionId<? extends Extension> ext)
Description copied from interface:Extensions
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- Specified by:
hasExtension
in interfaceExtensions
- Parameters:
ext
- (undocumented)- Returns:
- (undocumented)
-
isLocal
public boolean isLocal()
- Specified by:
isLocal
in interfaceActorRefImpl<scala.runtime.Nothing$>
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfaceInternalRecipientRef<scala.runtime.Nothing$>
- Returns:
true
if the actor is locally known to be terminated,false
if alive or uncertain.
-
log
public org.slf4j.Logger log()
Description copied from class:ActorSystem
ALogger
that can be used to emit log messages without specifying a more detailed source. Typically it is desirable to use the dedicatedLogger
available from each Actor’sTypedActorContext
as that ties the log entries to the actor.- Specified by:
log
in classActorSystem<scala.runtime.Nothing$>
- Returns:
- (undocumented)
-
logConfiguration
public void logConfiguration()
Description copied from class:ActorSystem
Log the configuration.- Specified by:
logConfiguration
in classActorSystem<scala.runtime.Nothing$>
-
name
public java.lang.String name()
- Specified by:
name
in classActorSystem<scala.runtime.Nothing$>
-
path
public ActorPath path()
Description copied from interface:ActorRef
The hierarchical path name of the referenced Actor. The lifecycle of the ActorRef is fully contained within the lifecycle of theActorPath
and more than one Actor instance can exist with the same path at different points in time, but not concurrently.
-
printTree
public java.lang.String printTree()
Description copied from class:ActorSystem
Create a string representation of the actor hierarchy within this system for debugging purposes.The format of the string is subject to change, i.e. no stable “API”.
- Specified by:
printTree
in classActorSystem<scala.runtime.Nothing$>
- Returns:
- (undocumented)
-
provider
public ActorRefProvider provider()
Description copied from interface:InternalRecipientRef
Get a reference to the actor ref provider which created this ref.- Specified by:
provider
in interfaceInternalRecipientRef<scala.runtime.Nothing$>
- Returns:
- (undocumented)
-
registerExtension
public <T extends Extension> T registerExtension(ExtensionId<T> ext)
- Specified by:
registerExtension
in interfaceExtensions
-
scheduler
public Scheduler scheduler()
Description copied from class:ActorSystem
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.- Specified by:
scheduler
in classActorSystem<scala.runtime.Nothing$>
- Returns:
- (undocumented)
-
sendSystem
public void sendSystem(SystemMessage signal)
- Specified by:
sendSystem
in interfaceActorRefImpl<scala.runtime.Nothing$>
-
settings
public Settings settings()
Description copied from class:ActorSystem
The core settings extracted from the supplied configuration.- Specified by:
settings
in classActorSystem<scala.runtime.Nothing$>
- Returns:
- (undocumented)
-
startTime
public long startTime()
Description copied from class:ActorSystem
Start-up time in milliseconds since the epoch.- Specified by:
startTime
in classActorSystem<scala.runtime.Nothing$>
- Returns:
- (undocumented)
-
systemActorOf
public <U> ActorRef<U> systemActorOf(Behavior<U> behavior, java.lang.String name, Props props)
Description copied from class:ActorSystem
Create an actor in the "/system" namespace. This actor will be shut down during system.terminate only after all user actors have terminated.This is only intended to be used by libraries (and Akka itself). Applications should use ordinary
spawn
.- Specified by:
systemActorOf
in classActorSystem<scala.runtime.Nothing$>
- Parameters:
behavior
- (undocumented)name
- (undocumented)props
- (undocumented)- Returns:
- (undocumented)
-
tell
public void tell(scala.runtime.Nothing$ message)
Description copied from interface:ActorRef
Send a message to the Actor referenced by this ActorRef using *at-most-once* messaging semantics.- Specified by:
tell
in interfaceActorRef<scala.runtime.Nothing$>
- Specified by:
tell
in interfaceRecipientRef<scala.runtime.Nothing$>
- Parameters:
message
- (undocumented)
-
terminate
public void terminate()
Description copied from class:ActorSystem
Terminates this actor system by runningCoordinatedShutdown
with reasonakka.actor.CoordinatedShutdown.ActorSystemTerminateReason
.If
akka.coordinated-shutdown.run-by-actor-system-terminate
is configured tooff
it will not runCoordinatedShutdown
, but theActorSystem
and its actors will still be terminated.This will stop the guardian actor, which in turn will recursively stop all its child actors, and finally the system guardian (below which the logging actors reside).
This is an asynchronous operation and completion of the termination can be observed with
ActorSystem.whenTerminated
orActorSystem.getWhenTerminated
.- Specified by:
terminate
in classActorSystem<scala.runtime.Nothing$>
-
threadFactory
public java.util.concurrent.ThreadFactory threadFactory()
Description copied from class:ActorSystem
A ThreadFactory that can be used if the transport needs to create any Threads- Specified by:
threadFactory
in classActorSystem<scala.runtime.Nothing$>
- Returns:
- (undocumented)
-
uptime
public long uptime()
Description copied from class:ActorSystem
Up-time of this actor system in seconds.- Specified by:
uptime
in classActorSystem<scala.runtime.Nothing$>
- Returns:
- (undocumented)
-
whenTerminated
public scala.concurrent.Future<Done> whenTerminated()
Description copied from class:ActorSystem
Scala API: Returns a Future which will be completed after the ActorSystem has been terminated and termination hooks have been executed. TheActorSystem
can be stopped withActorSystem.terminate
or by stopping the guardian actor.- Specified by:
whenTerminated
in classActorSystem<scala.runtime.Nothing$>
- Returns:
- (undocumented)
-
-