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 [[Akka.Actor.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: 0.8.0.0 (0.8.0.0)

Syntax

C++

Copy

public abstract class ActorSystem : ActorRefFactory, 
	IDisposable

Public MustInherit Class ActorSystem
	Implements ActorRefFactory, IDisposable

public ref class ActorSystem abstract : ActorRefFactory, 
	IDisposable

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

The ActorSystem type exposes the following members.

Constructors

	Name	Description
	ActorSystem	Initializes a new instance of the ActorSystem class

Top

Methods

	Name	Description
	ActorOf
	ActorSelection(String)
	ActorSelection(ActorPath)
	AwaitTermination	Block current thread until the system has been shutdown. This will block until after all on termination callbacks have been run.
	AwaitTermination(TimeSpan)	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. Returns true if the system was shutdown during the specified time; false if it timed out.
	AwaitTermination(TimeSpan, CancellationToken)	Block current thread until the system has been shutdown, or the specified timeout has elapsed, or the cancellationToken was canceled. This will block until after all on termination callbacks have been run. Returns true if the system was shutdown during the specified time; false if it timed out, or the cancellationToken was canceled.
	Create(String)	Creates the specified name.
	Create(String, Config)	Creates a new ActorSystem with the specified name, and the specified Config
	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)	Returns an extension registered to this ActorSystem
	GetExtensionT	Returns an extension registered to this ActorSystem
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HasExtension(Type)	Determines whether this instance has the specified extension.
	HasExtensionT	Determines whether this instance has the specified extension.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RegisterExtension
	Shutdown	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 ([!:ActorSystem.RegisterOnTermination]).
	Stop
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetExtension(Type, Object)	Tries to the get the extension of specified type.
	TryGetExtensionT(T)	Tries to the get the extension of specified type.
	WaitForShutdown	Obsolete. Block and prevent the main application thread from exiting unless the actor system is shut down.

Top

Extension Methods

	Name	Description
	ActorOf(ActionIActorDsl, String)	Overloaded. (Defined by ActExtensions.)
	ActorOf(ActionIActorDsl, IActorContext, String)	Overloaded. (Defined by ActExtensions.)
	ActorOfTActor(String)	Overloaded. (Defined by ActorRefFactoryExtensions.)
	AsInstanceOfT	(Defined by Extensions.)
	Match	Matches the specified target. (Defined by PatternMatch.)
	WithExtensionT	Overloaded. Loads the extension and casts it to the expected type if it's already registered (Defined by ActorSystemWithExtensions.)
	WithExtensionT(Type)	Overloaded. Registers a type and returns it if one doesn't yet exist (Defined by ActorSystemWithExtensions.)
	WithExtensionT, TI	Overloaded. Registers a type and returns it if one doesn't yet exist (Defined by ActorSystemWithExtensions.)

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.
	TerminationTask	Returns a task that will be completed when the system has terminated.

Top

Reference

Akka.Actor Namespace