akka.actor.mailbox
Interface DurableMailboxSettings

All Known Implementing Classes:

FileBasedMailboxSettings

public interface DurableMailboxSettings

Conventional organization of durable mailbox settings:

 akka {
   actor {
     my-durable-dispatcher {
       mailbox-type = "my.durable.mailbox"
       my-durable-mailbox {
         setting1 = 1
         setting2 = 2
       }
     }
   }
 }
 

where name=“my-durable-mailbox” in this example.

Method Summary

com.typesafe.config.Config	config() The extracted config section for this mailbox, which is the “name” section (if that exists), falling back to system defaults.
com.typesafe.config.Config	initialize() Obtain default extracted mailbox config section from userConfig and system.
java.lang.String	name() Name of this mailbox type for purposes of configuration scoping.
ActorSystem.Settings	systemSettings() A reference to the enclosing actor system.
com.typesafe.config.Config	userConfig() A reference to the config section which the user specified for this mailbox’s dispatcher.

Method Detail

systemSettings

ActorSystem.Settings systemSettings()

A reference to the enclosing actor system.

Returns:

(undocumented)

userConfig

com.typesafe.config.Config userConfig()

A reference to the config section which the user specified for this mailbox’s dispatcher.

Returns:

(undocumented)

config

com.typesafe.config.Config config()

The extracted config section for this mailbox, which is the “name” section (if that exists), falling back to system defaults. Typical implementation looks like:

 val config = initialize
 

Returns:

(undocumented)

name

java.lang.String name()

Name of this mailbox type for purposes of configuration scoping. Reference defaults go into “akka.actor.mailbox.”.

Returns:

(undocumented)

initialize

com.typesafe.config.Config initialize()

Obtain default extracted mailbox config section from userConfig and system.

Returns:

(undocumented)