Settings

class Settings extends AnyRef

Settings are 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 Documentation under "Configuration"

Source: ActorSystem.scala
See also: The Typesafe Config Library API Documentation

Linear Supertypes

AnyRef, Any

Type Hierarchy

Ordering

Alphabetic
By Inheritance

Inherited

Settings
AnyRef
Any

Implicitly

by any2stringadd
by StringFormat
by Ensuring
by ArrowAssoc

Hide All
Show All

Visibility

Public
Protected

Instance Constructors

new Settings(classLoader: ClassLoader, cfg: Config, name: String)
new Settings(classLoader: ClassLoader, cfg: Config, name: String, setup: ActorSystemSetup)

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
def +(other: String): String
Implicit
This member is added by an implicit conversion from Settings toany2stringadd[Settings] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (Settings, B)
Implicit
This member is added by an implicit conversion from Settings toArrowAssoc[Settings] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final val AddLoggingReceive: Boolean
final val AllowJavaSerialization: Boolean
final val ConfigVersion: String
final val CoordinatedShutdownRunByActorSystemTerminate: Boolean
final val CoordinatedShutdownTerminateActorSystem: Boolean
final val CreationTimeout: Timeout
final val Daemonicity: Boolean
final val DebugAutoReceive: Boolean
final val DebugEventStream: Boolean
final val DebugLifecycle: Boolean
final val DebugRouterMisconfiguration: Boolean
final val DebugUnhandledMessage: Boolean
final val DefaultVirtualNodesFactor: Int
final val FailMixedVersions: Boolean
final val FsmDebugEvent: Boolean
final val HasCluster: Boolean
final val Home: Option[String]
final val JvmExitOnFatalError: Boolean
final val JvmShutdownHooks: Boolean
final val LogConfigOnStart: Boolean
final val LogDeadLetters: Int
final val LogDeadLettersDuringShutdown: Boolean
final val LogDeadLettersSuspendDuration: Duration
final val LogLevel: String
final val LoggerStartTimeout: Timeout
final val Loggers: Seq[String]
final val LoggersDispatcher: String
final val LoggingFilter: String
final val NoSerializationVerificationNeededClassPrefix: Set[String]
final val ProviderClass: String
final val ProviderSelectionType: ProviderSelection
final val SchedulerClass: String
final val SerializeAllCreators: Boolean
final val SerializeAllMessages: Boolean
final val StdoutLogLevel: String
final val SupervisorStrategyClass: String
final val UnstartedPushTimeout: Timeout
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
final val config: Config
The backing Config of this ActorSystem's Settings
The backing Config of this ActorSystem's Settings
See also
The Typesafe Config Library API Documentation
def ensuring(cond: (Settings) => Boolean, msg: => Any): Settings
Implicit
This member is added by an implicit conversion from Settings toEnsuring[Settings] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Settings) => Boolean): Settings
Implicit
This member is added by an implicit conversion from Settings toEnsuring[Settings] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: => Any): Settings
Implicit
This member is added by an implicit conversion from Settings toEnsuring[Settings] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Settings
Implicit
This member is added by an implicit conversion from Settings toEnsuring[Settings] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate() @native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate() @native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final val name: String
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @native()
val setup: ActorSystemSetup
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Returns the String representation of the Config that this Settings is backed by
Returns the String representation of the Config that this Settings is backed by
Definition Classes
Settings → AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

final val EnableAdditionalSerializationBindings: Boolean
Annotations
@deprecated
Deprecated
(Since version 2.6.0) Always enabled from Akka 2.6.0
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated
(Since version 9)
def formatted(fmtstr: String): String
Implicit
This member is added by an implicit conversion from Settings toStringFormat[Settings] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@deprecated @inline()
Deprecated
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
def →[B](y: B): (Settings, B)
Implicit
This member is added by an implicit conversion from Settings toArrowAssoc[Settings] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate() @native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate() @native()
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @native()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated
(Since version 9)

Inherited from Any

Value Members

final def asInstanceOf[T0]: T0
Definition Classes
Any
final def isInstanceOf[T0]: Boolean
Definition Classes
Any

Inherited by implicit conversion any2stringadd fromSettings to any2stringadd[Settings]

Value Members

def +(other: String): String
Implicit
This member is added by an implicit conversion from Settings toany2stringadd[Settings] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd

Inherited by implicit conversion StringFormat fromSettings to StringFormat[Settings]

Value Members

def formatted(fmtstr: String): String
Implicit
This member is added by an implicit conversion from Settings toStringFormat[Settings] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@deprecated @inline()
Deprecated
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

Inherited by implicit conversion Ensuring fromSettings to Ensuring[Settings]

Value Members

def ensuring(cond: (Settings) => Boolean, msg: => Any): Settings
Implicit
This member is added by an implicit conversion from Settings toEnsuring[Settings] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Settings) => Boolean): Settings
Implicit
This member is added by an implicit conversion from Settings toEnsuring[Settings] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: => Any): Settings
Implicit
This member is added by an implicit conversion from Settings toEnsuring[Settings] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Settings
Implicit
This member is added by an implicit conversion from Settings toEnsuring[Settings] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

Inherited by implicit conversion ArrowAssoc fromSettings to ArrowAssoc[Settings]

Value Members

def ->[B](y: B): (Settings, B)
Implicit
This member is added by an implicit conversion from Settings toArrowAssoc[Settings] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
def →[B](y: B): (Settings, B)
Implicit
This member is added by an implicit conversion from Settings toArrowAssoc[Settings] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Ungrouped

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
def +(other: String): String
Implicit
This member is added by an implicit conversion from Settings toany2stringadd[Settings] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (Settings, B)
Implicit
This member is added by an implicit conversion from Settings toArrowAssoc[Settings] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final val AddLoggingReceive: Boolean
final val AllowJavaSerialization: Boolean
final val ConfigVersion: String
final val CoordinatedShutdownRunByActorSystemTerminate: Boolean
final val CoordinatedShutdownTerminateActorSystem: Boolean
final val CreationTimeout: Timeout
final val Daemonicity: Boolean
final val DebugAutoReceive: Boolean
final val DebugEventStream: Boolean
final val DebugLifecycle: Boolean
final val DebugRouterMisconfiguration: Boolean
final val DebugUnhandledMessage: Boolean
final val DefaultVirtualNodesFactor: Int
final val FailMixedVersions: Boolean
final val FsmDebugEvent: Boolean
final val HasCluster: Boolean
final val Home: Option[String]
final val JvmExitOnFatalError: Boolean
final val JvmShutdownHooks: Boolean
final val LogConfigOnStart: Boolean
final val LogDeadLetters: Int
final val LogDeadLettersDuringShutdown: Boolean
final val LogDeadLettersSuspendDuration: Duration
final val LogLevel: String
final val LoggerStartTimeout: Timeout
final val Loggers: Seq[String]
final val LoggersDispatcher: String
final val LoggingFilter: String
final val NoSerializationVerificationNeededClassPrefix: Set[String]
final val ProviderClass: String
final val ProviderSelectionType: ProviderSelection
final val SchedulerClass: String
final val SerializeAllCreators: Boolean
final val SerializeAllMessages: Boolean
final val StdoutLogLevel: String
final val SupervisorStrategyClass: String
final val UnstartedPushTimeout: Timeout
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
final val config: Config
The backing Config of this ActorSystem's Settings
The backing Config of this ActorSystem's Settings
See also
The Typesafe Config Library API Documentation
def ensuring(cond: (Settings) => Boolean, msg: => Any): Settings
Implicit
This member is added by an implicit conversion from Settings toEnsuring[Settings] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Settings) => Boolean): Settings
Implicit
This member is added by an implicit conversion from Settings toEnsuring[Settings] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: => Any): Settings
Implicit
This member is added by an implicit conversion from Settings toEnsuring[Settings] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Settings
Implicit
This member is added by an implicit conversion from Settings toEnsuring[Settings] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate() @native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate() @native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final val name: String
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @native()
val setup: ActorSystemSetup
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Returns the String representation of the Config that this Settings is backed by
Returns the String representation of the Config that this Settings is backed by
Definition Classes
Settings → AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final val EnableAdditionalSerializationBindings: Boolean
Annotations
@deprecated
Deprecated
(Since version 2.6.0) Always enabled from Akka 2.6.0
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated
(Since version 9)
def formatted(fmtstr: String): String
Implicit
This member is added by an implicit conversion from Settings toStringFormat[Settings] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@deprecated @inline()
Deprecated
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
def →[B](y: B): (Settings, B)
Implicit
This member is added by an implicit conversion from Settings toArrowAssoc[Settings] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Packages

Settings

class Settings extends AnyRef

Instance Constructors

Value Members

Deprecated Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Inherited by implicit conversion any2stringadd fromSettings to any2stringadd[Settings]

Value Members

Inherited by implicit conversion StringFormat fromSettings to StringFormat[Settings]

Value Members

Inherited by implicit conversion Ensuring fromSettings to Ensuring[Settings]

Value Members

Inherited by implicit conversion ArrowAssoc fromSettings to ArrowAssoc[Settings]

Value Members

Ungrouped

Settings