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

| Improve this Doc 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.
| Improve this Doc View Source

BoundedMessageQueue(Int32, TimeSpan)

Initializes a new instance of the BoundedMessageQueue class.

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

TBD
TimeSpan pushTimeOut

TBD
Exceptions
Type Condition
ArgumentException

This exception is thrown if the given boundedCapacity is negative.

Properties

| Improve this Doc View Source

Count

Interface to be implemented by all mailbox message queues

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

HasMessages

Interface to be implemented by all mailbox message queues

Declaration
public bool HasMessages { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

PushTimeOut

The push timeout for this bounded queue.

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

Methods

| Improve this Doc 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

The owner of this message queue if available, "/deadletters" otherwise.
IMessageQueue deadletters

The dead letters message queue.
| Improve this Doc 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

The receiver of the messages.

This field is only used in a couple of places, but it should not be removed.
Envelope envelope

The envelope to enqueue

| Improve this Doc 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

The envelope that was dequeued

Returns
Type Description
Boolean

true if there's a message in the queue. false otherwise.

Implements

Extension Methods