Class BoundedMessageQueue

An Bounded mailbox message queue.

Inheritance
object
BoundedMessageQueue
Implements
Inherited Members
Namespace: Akka.Dispatch.MessageQueues
Assembly: Akka.dll
Syntax
public class BoundedMessageQueue : IMessageQueue, IBoundedMessageQueueSemantics, ISemantics

Constructors

| Edit this page View Source

BoundedMessageQueue(Config)

Creates a new bounded message queue.

Declaration
public BoundedMessageQueue(Config config)
Parameters
Type Name Description
Config config

The configuration for this mailbox.
| Edit this page View Source

BoundedMessageQueue(int, TimeSpan)

Initializes a new instance of the BoundedMessageQueue class.

Declaration
public BoundedMessageQueue(int boundedCapacity, TimeSpan pushTimeOut)
Parameters
Type Name Description
int boundedCapacity

TBD
TimeSpan pushTimeOut

TBD
Exceptions
Type Condition
ArgumentException

This exception is thrown if the given boundedCapacity is negative.

Properties

| Edit this page View Source

Count

Interface to be implemented by all mailbox message queues

Declaration
public int Count { get; }
Property Value
Type Description
int
| Edit this page View Source

HasMessages

Interface to be implemented by all mailbox message queues

Declaration
public bool HasMessages { get; }
Property Value
Type Description
bool
| Edit this page View Source

PushTimeOut

The push timeout for this bounded queue.

Declaration
public TimeSpan PushTimeOut { get; set; }
Property Value
Type Description
TimeSpan

Methods

| Edit this page View Source

CleanUp(IActorRef, IMessageQueue)

Interface to be implemented by all mailbox message queues

Declaration
public void CleanUp(IActorRef owner, IMessageQueue deadletters)
Parameters
Type Name Description
IActorRef owner
IMessageQueue deadletters
| Edit this page View Source

Enqueue(IActorRef, Envelope)

Interface to be implemented by all mailbox message queues

Declaration
public void Enqueue(IActorRef receiver, Envelope envelope)
Parameters
Type Name Description
IActorRef receiver
Envelope envelope
| Edit this page View Source

TryDequeue(out Envelope)

Interface to be implemented by all mailbox message queues

Declaration
public bool TryDequeue(out Envelope envelope)
Parameters
Type Name Description
Envelope envelope
Returns
Type Description
bool

Implements

Extension Methods