Class Settings

This class represents the overall ActorSystem settings which also provides a convenient access to the Config object. For more detailed information about the different possible configuration options, look in the Akka.NET Documentation under Configuration (https://getakka.net/articles/configuration/config.html).

Inheritance

Object

Settings

PersistenceSettings

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Namespace: Akka.Actor

Assembly: Akka.dll

Syntax

public class Settings

Constructors

| Improve this Doc View Source

Settings(ActorSystem, Config)

Initializes a new instance of the Settings class.

Declaration

public Settings(ActorSystem system, Config config)

Parameters

Type	Name	Description
ActorSystem	system	The system.
Config	config	The configuration.

Exceptions

Type	Condition
ConfigurationException	This exception is thrown if the 'akka.actor.provider' configuration item is not a valid type name or a valid actor ref provider.

| Improve this Doc View Source

Settings(ActorSystem, Config, ActorSystemSetup)

Initializes a new instance of the Settings class.

Declaration

public Settings(ActorSystem system, Config config, ActorSystemSetup setup)

Parameters

Type	Name	Description
ActorSystem	system	The system.
Config	config	The configuration.
ActorSystemSetup	setup	The setup class used to help bootstrap the ActorSystem

Exceptions

Type	Condition
ConfigurationException	This exception is thrown if the 'akka.actor.provider' configuration item is not a valid type name or a valid actor ref provider.

Properties

| Improve this Doc View Source

AddLoggingReceive

Gets a value indicating whether [add logging receive].

Declaration

public bool AddLoggingReceive { get; }

Property Value

Type	Description
Boolean	`true` if [add logging receive]; otherwise, `false`.

| Improve this Doc View Source

AskTimeout

Gets the default timeout for Futures.Ask calls.

Declaration

public TimeSpan AskTimeout { get; }

Property Value

Type	Description
TimeSpan	The ask timeout.

| Improve this Doc View Source

Config

Gets the configuration.

Declaration

public Config Config { get; }

Property Value

Type	Description
Config	The configuration.

| Improve this Doc View Source

ConfigVersion

Gets the configuration version.

Declaration

public string ConfigVersion { get; }

Property Value

Type	Description
String	The configuration version.

| Improve this Doc View Source

CoordinatedShutdownRunByActorSystemTerminate

Declaration

public bool CoordinatedShutdownRunByActorSystemTerminate { get; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

CoordinatedShutdownTerminateActorSystem

Declaration

public bool CoordinatedShutdownTerminateActorSystem { get; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

CreationTimeout

Gets the creation timeout.

Declaration

public TimeSpan CreationTimeout { get; }

Property Value

Type	Description
TimeSpan	The creation timeout.

| Improve this Doc View Source

DebugAutoReceive

Gets a value indicating whether [debug automatic receive].

Declaration

public bool DebugAutoReceive { get; }

Property Value

Type	Description
Boolean	`true` if [debug automatic receive]; otherwise, `false`.

| Improve this Doc View Source

DebugEventStream

Gets a value indicating whether [debug event stream].

Declaration

public bool DebugEventStream { get; }

Property Value

Type	Description
Boolean	`true` if [debug event stream]; otherwise, `false`.

| Improve this Doc View Source

DebugLifecycle

Gets a value indicating whether [debug lifecycle].

Declaration

public bool DebugLifecycle { get; }

Property Value

Type	Description
Boolean	`true` if [debug lifecycle]; otherwise, `false`.

| Improve this Doc View Source

DebugRouterMisconfiguration

Gets a value indicating whether [debug router misconfiguration].

Declaration

public bool DebugRouterMisconfiguration { get; }

Property Value

Type	Description
Boolean	`true` if [debug router misconfiguration]; otherwise, `false`.

| Improve this Doc View Source

DebugTimerScheduler

Should TimerScheduler emit debug logs

Declaration

public bool DebugTimerScheduler { get; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

DebugUnhandledMessage

Gets a value indicating whether [debug unhandled message].

Declaration

public bool DebugUnhandledMessage { get; }

Property Value

Type	Description
Boolean	`true` if [debug unhandled message]; otherwise, `false`.

| Improve this Doc View Source

DefaultVirtualNodesFactor

The number of default virtual nodes to use with ConsistentHashingRoutingLogic.

Declaration

public int DefaultVirtualNodesFactor { get; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

EmitActorTelemetry

When set to true, all actors will emit IActorTelemetryEvents when they are created, stopped, or restarted.

Declaration

public bool EmitActorTelemetry { get; }

Property Value

Type	Description
Boolean

Remarks

Defaults to false.

| Improve this Doc View Source

FsmDebugEvent

TBD

Declaration

public bool FsmDebugEvent { get; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

HasCluster

Used to indicate whether or not clustering is enabled for this ActorSystem.

Declaration

public bool HasCluster { get; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

Home

Gets the home.

Declaration

public string Home { get; }

Property Value

Type	Description
String	The home.

| Improve this Doc View Source

LogConfigOnStart

Gets a value indicating whether [log configuration on start].

Declaration

public bool LogConfigOnStart { get; }

Property Value

Type	Description
Boolean	`true` if [log configuration on start]; otherwise, `false`.

| Improve this Doc View Source

LogDeadLetters

Gets the log dead letters.

Declaration

public int LogDeadLetters { get; }

Property Value

Type	Description
Int32	The log dead letters.

| Improve this Doc View Source

LogDeadLettersDuringShutdown

Gets a value indicating whether [log dead letters during shutdown].

Declaration

public bool LogDeadLettersDuringShutdown { get; }

Property Value

Type	Description
Boolean	`true` if [log dead letters during shutdown]; otherwise, `false`.

| Improve this Doc View Source

LogDeadLettersSuspendDuration

TBD

Declaration

public TimeSpan LogDeadLettersSuspendDuration { get; }

Property Value

Type	Description
TimeSpan

| Improve this Doc View Source

LogFilter

Used to filter log messages based on the log source and message content.

Declaration

public LogFilterEvaluator LogFilter { get; }

Property Value

Type	Description
LogFilterEvaluator

Remarks

Not enabled by default and may not be supported in all third party logging implementations.

| Improve this Doc View Source

LogFormatter

The default formatter used by the ILoggingAdapter.

Declaration

public ILogMessageFormatter LogFormatter { get; }

Property Value

Type	Description
ILogMessageFormatter

Remarks

Can be overridden on individual Context.GetLogger() calls.

| Improve this Doc View Source

LoggerAsyncStart

Gets the logger start timeout.

Declaration

public bool LoggerAsyncStart { get; }

Property Value

Type	Description
Boolean	The logger start timeout.

| Improve this Doc View Source

Loggers

Gets the loggers.

Declaration

public IList<string> Loggers { get; }

Property Value

Type	Description
IList<String>	The loggers.

| Improve this Doc View Source

LoggersDispatcher

Gets the default loggers dispatcher.

Declaration

public string LoggersDispatcher { get; }

Property Value

Type	Description
String	The loggers dispatcher.

| Improve this Doc View Source

LoggerStartTimeout

Gets the logger start timeout.

Declaration

public TimeSpan LoggerStartTimeout { get; }

Property Value

Type	Description
TimeSpan	The logger start timeout.

| Improve this Doc View Source

LogLevel

Gets the log level.

Declaration

public string LogLevel { get; }

Property Value

Type	Description
String	The log level.

| Improve this Doc View Source

LogSerializerOverrideOnStart

Gets a value indicating whether [log serializer override on start].

Declaration

public bool LogSerializerOverrideOnStart { get; }

Property Value

Type	Description
Boolean	`true` if [log serializer override on start]; otherwise, `false`.

| Improve this Doc View Source

ProviderClass

Gets the provider class.

Declaration

public string ProviderClass { get; }

Property Value

Type	Description
String	The provider class.

| Improve this Doc View Source

ProviderSelectionType

INTENRAL API

Declaration

public ProviderSelection ProviderSelectionType { get; }

Property Value

Type	Description
ProviderSelection

| Improve this Doc View Source

SchedulerClass

Gets the scheduler implementation used by this system.

Declaration

public string SchedulerClass { get; }

Property Value

Type	Description
String

| Improve this Doc View Source

SchedulerShutdownTimeout

TBD

Declaration

public TimeSpan SchedulerShutdownTimeout { get; }

Property Value

Type	Description
TimeSpan

| Improve this Doc View Source

SerializeAllCreators

Gets a value indicating whether [serialize all creators].

Declaration

public bool SerializeAllCreators { get; }

Property Value

Type	Description
Boolean	`true` if [serialize all creators]; otherwise, `false`.

| Improve this Doc View Source

SerializeAllMessages

Gets a value indicating whether [serialize all messages].

Declaration

public bool SerializeAllMessages { get; }

Property Value

Type	Description
Boolean	`true` if [serialize all messages]; otherwise, `false`.

| Improve this Doc View Source

Setup

The setup used to help bootstrap this ActorSystem.

Declaration

public ActorSystemSetup Setup { get; }

Property Value

Type	Description
ActorSystemSetup

| Improve this Doc View Source

StdoutLogger

Returns a singleton instance of the standard out logger.

Declaration

public MinimalLogger StdoutLogger { get; }

Property Value

Type	Description
MinimalLogger

| Improve this Doc View Source

StdoutLogLevel

Gets the stdout log level.

Declaration

public string StdoutLogLevel { get; }

Property Value

Type	Description
String	The stdout log level.

| Improve this Doc View Source

SupervisorStrategyClass

Gets the supervisor strategy class.

Declaration

public string SupervisorStrategyClass { get; }

Property Value

Type	Description
String	The supervisor strategy class.

| Improve this Doc View Source

System

Gets the system.

Declaration

public ActorSystem System { get; }

Property Value

Type	Description
ActorSystem	The system.

| Improve this Doc View Source

UnstartedPushTimeout

Gets the unstarted push timeout.

Declaration

public TimeSpan UnstartedPushTimeout { get; }

Property Value

Type	Description
TimeSpan	The unstarted push timeout.

Methods

| Improve this Doc View Source

InjectTopLevelFallback(Config)

Injects a system config at the top of the fallback chain

Declaration

public void InjectTopLevelFallback(Config config)

Parameters

Type	Name	Description
Config	config	TBD

| Improve this Doc View Source

ToString()

Declaration

public override string ToString()

Returns

Type	Description
String

Overrides

Object.ToString()

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(Object)