Class Mailboxes

Contains the directory of all MailboxTypes registered and configured with a given ActorSystem.

Inheritance
object
Mailboxes
Inherited Members
Namespace: Akka.Dispatch
Assembly: Akka.dll
Syntax
public class Mailboxes

Constructors

| Edit this page View Source

Mailboxes(ActorSystem)

Initializes a new instance of the Mailboxes class.

Declaration
public Mailboxes(ActorSystem system)
Parameters
Type Name Description
ActorSystem system

The system.

Fields

| Edit this page View Source

DefaultMailboxId

TBD

Declaration
public static readonly string DefaultMailboxId
Field Value
Type Description
string
| Edit this page View Source

NoMailboxRequirement

TBD

Declaration
public static readonly string NoMailboxRequirement
Field Value
Type Description
string

Properties

| Edit this page View Source

DeadLetterMailbox

TBD

Declaration
public DeadLetterMailbox DeadLetterMailbox { get; }
Property Value
Type Description
DeadLetterMailbox

Methods

| Edit this page View Source

GetMailboxType(Props, Config)

TBD

Declaration
public MailboxType GetMailboxType(Props props, Config dispatcherConfig)
Parameters
Type Name Description
Props props

TBD
Config dispatcherConfig

TBD
Returns
Type Description
MailboxType

TBD
Exceptions
Type Condition
ArgumentException

This exception is thrown if the 'mailbox-requirement' in the given dispatcherConfig isn't met.
| Edit this page View Source

GetRequiredType(Type)

TBD

Declaration
public Type GetRequiredType(Type actorType)
Parameters
Type Name Description
Type actorType

TBD
Returns
Type Description
Type

TBD
| Edit this page View Source

HasRequiredType(Type)

Check if this actor class can have a required message queue type.

Declaration
public bool HasRequiredType(Type actorType)
Parameters
Type Name Description
Type actorType

The type to check.
Returns
Type Description
bool

true if this actor has a message queue type requirement. false otherwise.
| Edit this page View Source

Lookup(string)

Returns a MailboxType as specified in configuration, based on the id, or if not defined null.

Declaration
public MailboxType Lookup(string id)
Parameters
Type Name Description
string id

The ID of the mailbox to lookup
Returns
Type Description
MailboxType

The MailboxType specified in configuration or if not defined null.
Exceptions
Type Condition
ConfigurationException

This exception is thrown if the mailbox type is not configured or the system could not load or find the type specified.
ArgumentException

This exception is thrown if the mailbox type could not be instantiated.
| Edit this page View Source

LookupByQueueType(Type)

Returns a MailboxType as specified in configuration, based on the type, or if not defined null.

Declaration
public MailboxType LookupByQueueType(Type queueType)
Parameters
Type Name Description
Type queueType

The mailbox we need given the queue requirements.
Returns
Type Description
MailboxType

A MailboxType as specified in configuration, based on the type, or if not defined null.
Exceptions
Type Condition
ConfigurationException

This exception is thrown if a mapping is not configured for the given queueType.
| Edit this page View Source

ProducesMessageQueue(Type)

Check if this MailboxType implements the IProducesMessageQueue<TQueue> interface.

Declaration
public bool ProducesMessageQueue(Type mailboxType)
Parameters
Type Name Description
Type mailboxType

The type of the MailboxType to check.
Returns
Type Description
bool

true if this mailboxtype produces queues. false otherwise.

Extension Methods