MailboxSelector

java.lang.Object

org.apache.pekko.actor.typed.Props

org.apache.pekko.actor.typed.MailboxSelector

All Implemented Interfaces:: Serializable, scala.Equals, scala.Product

Direct Known Subclasses:: PropsImpl.BoundedMailboxSelector, PropsImpl.DefaultMailboxSelector, PropsImpl.MailboxFromConfigSelector

public abstract class MailboxSelector extends Props

Not for user extension.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor

Description

MailboxSelector()
Method Summary

Modifier and Type

Method

Description

static MailboxSelector

bounded(int capacity)

A mailbox with a max capacity after which new messages are dropped (passed to deadletters).

static MailboxSelector

defaultMailbox()

Java API: The default mailbox is SingleConsumerOnlyUnboundedMailbox

static MailboxSelector

fromConfig(String path)

Select a mailbox from the config file using an absolute config path.

Methods inherited from class org.apache.pekko.actor.typed.Props
empty, withDispatcherDefault, withDispatcherFromConfig, withDispatcherSameAsParent, withMailboxFromConfig

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

Methods inherited from interface scala.Equals
canEqual, equals

Methods inherited from interface scala.Product
productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

Constructor Details
- MailboxSelector
  
  public MailboxSelector()
Method Details
- defaultMailbox
  
  public static MailboxSelector defaultMailbox()
  
  Java API: The default mailbox is SingleConsumerOnlyUnboundedMailbox
- bounded
  
  public static MailboxSelector bounded(int capacity)
  
  A mailbox with a max capacity after which new messages are dropped (passed to deadletters).
  
  Parameters:
  
  capacity - The maximum number of messages in the mailbox before new messages are dropped
- fromConfig
  
  public static MailboxSelector fromConfig(String path)
  
  Select a mailbox from the config file using an absolute config path.
  This is a power user settings default or bounded should be preferred unless you know what you are doing.