Class BoundedMailbox

The default bounded mailbox implementation

Inheritance
Object
MailboxType
BoundedMailbox
Implements
Inherited Members
Namespace: Akka.Dispatch
Assembly: Akka.dll
Syntax
public sealed class BoundedMailbox : MailboxType, IProducesMessageQueue<BoundedMessageQueue>, IProducesPushTimeoutSemanticsMailbox

Constructors

| Improve this Doc View Source

BoundedMailbox(Settings, Config)

Constructor used for creating a MailboxType

Declaration
public BoundedMailbox(Settings settings, Config config)
Parameters
Type Name Description
Settings settings

The Settings for this system.
Config config

The Config for this mailbox.
Exceptions
Type Condition
ArgumentException

This exception is thrown if the 'mailbox-capacity' in config or the 'mailbox-push-timeout-time' in config is negative.

Properties

| Improve this Doc View Source

Capacity

The capacity of this mailbox.

Declaration
public int Capacity { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

PushTimeout

The push timeout value. Will throw a timeout error after this period of time

Declaration
public TimeSpan PushTimeout { get; }
Property Value
Type Description
TimeSpan

Methods

| Improve this Doc View Source

Create(IActorRef, ActorSystem)

A factory to create IMessageQueues for an optionally provided IActorContext.

Declaration
public override IMessageQueue Create(IActorRef owner, ActorSystem system)
Parameters
Type Name Description
IActorRef owner
ActorSystem system
Returns
Type Description
IMessageQueue
Overrides
Remarks

Possibly important notice.

When implementing a custom MailboxType, be aware that there is special semantics attached to ActorOf(Props, String) in that sending the returned IActorRef may, for a short period of time, enqueue the messages first in a dummy queue. Top-level actors are created in two steps, and only after the guardian actor ahs performed that second step will all previously sent messages be transferred from the dummy queue to the real mailbox.

Implemented as an abstract class in order to enforce constructor requirements.

Implements

Extension Methods