Click or drag to resize
Akka.NETActorSystem 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`):
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

Namespace:  Akka.Actor
Assembly:  Akka (in Akka.dll) Version: 1.2.1.36 (1.2.1.36)
Syntax
public abstract class ActorSystem : IActorRefFactory, 
	IDisposable

The ActorSystem type exposes the following members.

Constructors
  NameDescription
Protected methodActorSystem
Initializes a new instance of the ActorSystem class
Top
Properties
  NameDescription
Public propertyDeadLetters
Gets the dead letters.
Public propertyDispatchers
Gets the dispatchers.
Public propertyEventStream
Gets the event stream.
Public propertyLog
Gets the log
Public propertyMailboxes
Gets the mailboxes.
Public propertyName
Gets the name of this system.
Public propertyScheduler
Gets the scheduler.
Public propertySerialization
Gets the serialization.
Public propertySettings
Gets the settings.
Public propertyStartTime
Start-up time since the epoch.
Public propertyUptime
Up-time of this actor system.
Public propertyWhenTerminated
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
  NameDescription
Public methodActorOf
Interface IActorRefFactory
Public methodActorSelection(String)
Interface IActorRefFactory
Public methodActorSelection(ActorPath)
Interface IActorRefFactory
Public methodStatic memberCreate(String)
Creates a new ActorSystem with the specified name.
Public methodStatic memberCreate(String, Config)
Creates a new ActorSystem with the specified name and configuration.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetExtension(IExtensionId)
Retrieves the specified extension that is registered to this actor system.
Public methodGetExtensionT
Retrieves an extension with the specified type that is registered to this actor system.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHasExtension(Type)
Determines whether this actor system has an extension with the specified type.
Public methodHasExtensionT
Determines whether this actor system has the specified extension.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRegisterExtension
Registers the specified extension with this actor system.
Public methodRegisterOnTermination

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.

Public methodStop
Stops the specified actor permanently.
Public methodTerminate

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.

Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryGetExtension(Type, Object)
Tries to retrieve an extension with the specified type.
Public methodTryGetExtensionT(T)
Tries to retrieve an extension with the specified type
Top
Extension Methods
  NameDescription
Public Extension MethodActorOf(ActionIActorDsl, String)Overloaded.
TBD
(Defined by ActExtensions.)
Public Extension MethodActorOf(ActionIActorDsl, IActorContext, String)Overloaded.
TBD
(Defined by ActExtensions.)
Public Extension MethodActorOfTActor(String)Overloaded.
TBD
(Defined by ActorRefFactoryExtensions.)
Public Extension MethodActorSelection
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.)
Public Extension MethodAddDependencyResolver
Registers a dependency resolver with a given actor system.
(Defined by Extensions.)
Public Extension MethodAsInstanceOfT
TBD
(Defined by Extensions.)
Public Extension MethodDI
Creates an adapter used to generate Props configuration objects using the DI extension using a given actor system.
(Defined by Extensions.)
Public Extension MethodDistributedData
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.)
Public Extension MethodMatchOverloaded.
Matches the specified target.
(Defined by PatternMatch.)
Public Extension MethodMatchTOverloaded.
Matches the specified target and return a result of target processing.
(Defined by PatternMatch.)
Public Extension MethodMaterializer

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.)
Public Extension MethodReadJournalForTJournal (Defined by PersistenceQueryExtensions.)
Public Extension MethodTcp
TBD
(Defined by TcpExtensions.)
Public Extension MethodTcpStream
TBD
(Defined by TcpStreamExtensions.)
Public Extension MethodUdp
TBD
(Defined by UdpExtensions.)
Public Extension MethodWithExtensionTOverloaded.
Retrieves the extension specified by a given type, T, from a given actor system.
(Defined by ActorSystemWithExtensions.)
Public Extension MethodWithExtensionT(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.)
Public Extension MethodWithExtensionT, TIOverloaded.
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
See Also