ActorSystem Class

ActorSystem Class

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 Props for details on `props`):

Copy

system.ActorOf(props, "name");
system.ActorOf(props);
system.ActorOf(Props.Create(typeof(MyActor)), "name");
system.ActorOf(Props.Create(() => new MyActor(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.

Inheritance Hierarchy

SystemObject
Akka.ActorActorSystem
Akka.ActorExtendedActorSystem

Namespace: Akka.Actor
Assembly: Akka (in Akka.dll) Version: 1.2.3.129 (1.2.3.129)

Syntax

Copy

public abstract class ActorSystem : IActorRefFactory, 
	IDisposable

[<AbstractClassAttribute>]
type ActorSystem =  
    class
        interface IActorRefFactory
        interface IDisposable
    end

The ActorSystem type exposes the following members.

Constructors

	Name	Description
	ActorSystem	Initializes a new instance of the ActorSystem class

Top

Properties

	Name	Description
	DeadLetters	Gets the dead letters.
	Dispatchers	Gets the dispatchers.
	EventStream	Gets the event stream.
	Log	Gets the log
	Mailboxes	Gets the mailboxes.
	Name	Gets the name of this system.
	Scheduler	Gets the scheduler.
	Serialization	Gets the serialization.
	Settings	Gets the settings.
	StartTime	Start-up time since the epoch.
	Uptime	Up-time of this actor system.
	WhenTerminated	Returns a task 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 task completes.

Top

Methods

	Name	Description
	ActorOf	Interface IActorRefFactory
	ActorSelection(String)	Interface IActorRefFactory
	ActorSelection(ActorPath)	Interface IActorRefFactory
	Create(String)	Creates a new ActorSystem with the specified name.
	Create(String, Config)	Creates a new ActorSystem with the specified name and configuration.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetExtension(IExtensionId)	Retrieves the specified extension that is registered to this actor system.
	GetExtensionT	Retrieves an extension with the specified type that is registered to this actor system.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HasExtension(Type)	Determines whether this actor system has an extension with the specified type.
	HasExtensionT	Determines whether this actor system has the specified extension.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RegisterExtension	Registers the specified extension with this actor system.
	RegisterOnTermination	Registers 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.
	Stop	Stops the specified actor permanently.
	Terminate	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 (RegisterOnTermination(Action)). Be careful to not schedule any operations on completion of the returned task using the `dispatcher` of this actor system as it will have been shut down before the task completes.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetExtension(Type, Object)	Tries to retrieve an extension with the specified type.
	TryGetExtensionT(T)	Tries to retrieve an extension with the specified type

Top

Extension Methods

	Name	Description
	ActorOf(ActionIActorDsl, String)	Overloaded. TBD (Defined by ActExtensions.)
	ActorOf(ActionIActorDsl, IActorContext, String)	Overloaded. TBD (Defined by ActExtensions.)
	ActorOfTActor(String)	Overloaded. TBD (Defined by ActorRefFactoryExtensions.)
	ActorSelection	Construct an ActorSelection from the given string representing a path relative to the given target. This operation has to create all the matching magic, so it is preferable to cache its result if the intention is to send messages frequently. (Defined by ActorRefFactoryExtensions.)
	AddDependencyResolver	Registers a dependency resolver with a given actor system. (Defined by Extensions.)
	AsInstanceOfT	TBD (Defined by Extensions.)
	DI	Creates an adapter used to generate Props configuration objects using the DI extension using a given actor system. (Defined by Extensions.)
	DistributedData	Returns th DistributedData(ActorSystem) extension configured for provided system. Configuration is supplied automatically from HOCON config under the path: `akka.cluster.distributed-data` (Defined by DistributedDataExtensions.)
	Match	Overloaded. Matches the specified target. (Defined by PatternMatch.)
	MatchT	Overloaded. Matches the specified target and return a result of target processing. (Defined by PatternMatch.)
	Materializer	Creates a ActorMaterializer which will execute every step of a transformation pipeline within its own ActorBase. The required IActorRefFactory (which can be either an ActorSystem or an IActorContext) will be used to create one actor that in turn creates actors for the transformation steps. The materializer's ActorMaterializerSettings will be obtained from the configuration of the context's underlying ActorSystem. The namePrefix is used as the first part of the names of the actors running the processing steps. The default namePrefix is "flow". The actor names are built up of namePrefix-flowNumber-flowStepNumber-stepName. (Defined by ActorMaterializerExtensions.)
	ReadJournalForTJournal	(Defined by PersistenceQueryExtensions.)
	Tcp	TBD (Defined by TcpExtensions.)
	TcpStream	TBD (Defined by TcpStreamExtensions.)
	Udp	TBD (Defined by UdpExtensions.)
	WithExtensionT	Overloaded. Retrieves the extension specified by a given type, T, from a given actor system. (Defined by ActorSystemWithExtensions.)
	WithExtensionT(Type)	Overloaded. Retrieves the extension specified by a given type, T, from a given actor system. If the extension does not exist within the actor system, then the extension specified by extensionId is registered to the actor system. (Defined by ActorSystemWithExtensions.)
	WithExtensionT, TI	Overloaded. Retrieves the extension specified by a given type, T, from a given actor system. If the extension does not exist within the actor system, then the extension specified by TI is registered to the actor system. (Defined by ActorSystemWithExtensions.)

Top

Reference

Akka.Actor Namespace