java.lang.Object
- akka.dispatch.Mailboxes

public class Mailboxes
extends java.lang.Object

Constructor Summary

Constructors
Constructor Description

Mailboxes(ActorSystem.Settings settings, EventStream eventStream, DynamicAccess dynamicAccess, ActorRef deadLetters)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static java.lang.String`	`BoundedCapacityPrefix()`
`Mailbox`	`deadLetterMailbox()`
`static java.lang.String`	`DefaultMailboxId()`
`EventStream`	`eventStream()`
`java.lang.Class<?>`	`getMailboxRequirement(com.typesafe.config.Config config)`
`protected MailboxType`	`getMailboxType(Props props, com.typesafe.config.Config dispatcherConfig)`	Finds out the mailbox type for an actor based on configuration, props and requirements.
`java.lang.Class<?>`	`getProducedMessageQueueType(MailboxType mailboxType)`
`java.lang.Class<?>`	`getRequiredType(java.lang.Class<? extends Actor> actorClass)`	Return the required message queue type for this class if any.
`boolean`	`hasRequiredType(java.lang.Class<? extends Actor> actorClass)`	Check if this class can have a required message queue type.
`MailboxType`	`lookup(java.lang.String id)`	Returns a mailbox type as specified in configuration, based on the id, or if not defined None.
`MailboxType`	`lookupByQueueType(java.lang.Class<?> queueType)`	Returns a mailbox type as specified in configuration, based on the type, or if not defined None.
`static java.lang.String`	`NoMailboxRequirement()`
`void`	`onDeadLetterMailboxEnqueue(ActorRef receiver, Envelope envelope)`
`ActorSystem.Settings`	`settings()`
`int`	`stashCapacity(java.lang.String dispatcher, java.lang.String mailbox)`	INTERNAL API: The capacity of the stash.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Mailboxes

public Mailboxes(ActorSystem.Settings settings,
                 EventStream eventStream,
                 DynamicAccess dynamicAccess,
                 ActorRef deadLetters)

Method Detail

DefaultMailboxId

public static final java.lang.String DefaultMailboxId()

NoMailboxRequirement

public static final java.lang.String NoMailboxRequirement()

BoundedCapacityPrefix

public static final java.lang.String BoundedCapacityPrefix()

settings

public ActorSystem.Settings settings()

eventStream
```
public EventStream eventStream()
```

deadLetterMailbox
```
public Mailbox deadLetterMailbox()
```

onDeadLetterMailboxEnqueue

public void onDeadLetterMailboxEnqueue(ActorRef receiver,
                                       Envelope envelope)

lookup
```
public MailboxType lookup(java.lang.String id)
```
Returns a mailbox type as specified in configuration, based on the id, or if not defined None.

lookupByQueueType
```
public MailboxType lookupByQueueType(java.lang.Class<?> queueType)
```
Returns a mailbox type as specified in configuration, based on the type, or if not defined None.

getRequiredType

public java.lang.Class<?> getRequiredType(java.lang.Class<? extends Actor> actorClass)

Return the required message queue type for this class if any.

getMailboxRequirement

public java.lang.Class<?> getMailboxRequirement(com.typesafe.config.Config config)

getProducedMessageQueueType

public java.lang.Class<?> getProducedMessageQueueType(MailboxType mailboxType)

getMailboxType

protected MailboxType getMailboxType(Props props,
                                     com.typesafe.config.Config dispatcherConfig)

Finds out the mailbox type for an actor based on configuration, props and requirements.

hasRequiredType

public boolean hasRequiredType(java.lang.Class<? extends Actor> actorClass)

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

stashCapacity

public final int stashCapacity(java.lang.String dispatcher,
                               java.lang.String mailbox)

INTERNAL API: The capacity of the stash. Configured in the actor's mailbox or dispatcher config.

Class Mailboxes

Constructor Summary