t

akka.dispatch

MessageQueue

trait MessageQueue extends AnyRef

A MessageQueue is one of the core components in forming an Akka Mailbox. The MessageQueue is where the normal messages that are sent to Actors will be enqueued (and subsequently dequeued) It needs to at least support N producers and 1 consumer thread-safely.

Source
Mailbox.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
MessageQueue, BoundedControlAwareMessageQueueSemantics, MessageQueue, BoundedDequeBasedMessageQueue, MessageQueue, BoundedNodeMessageQueue, MessageQueue, BoundedQueueBasedMessageQueue, MessageQueue, ControlAwareMessageQueueSemantics, DequeBasedMessageQueue, NodeMessageQueue, QueueBasedMessageQueue, MessageQueue, UnboundedControlAwareMessageQueueSemantics, MessageQueue, UnboundedDequeBasedMessageQueue, MessageQueue, MessageQueue, UnboundedQueueBasedMessageQueue, MessageQueue
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MessageQueue
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def cleanUp(owner: ActorRef, deadLetters: MessageQueue): Unit

    Called when the mailbox this queue belongs to is disposed of.

    Called when the mailbox this queue belongs to is disposed of. Normally it is expected to transfer all remaining messages into the dead letter queue which is passed in. The owner of this MessageQueue is passed in if available (e.g. for creating DeadLetters()), “/deadletters” otherwise.

    Note that we implement the method in a recursive manner mainly for atomicity (not touching the queue twice).

  2. abstract def dequeue(): Envelope

    Try to dequeue the next message from this queue, return null failing that.

  3. abstract def enqueue(receiver: ActorRef, handle: Envelope): Unit

    Try to enqueue the message to this queue, or throw an exception.

  4. abstract def hasMessages: Boolean

    Indicates whether this queue is non-empty.

  5. abstract def numberOfMessages: Int

    Should return the current number of messages held in this queue; may always return 0 if no other value is available efficiently.

    Should return the current number of messages held in this queue; may always return 0 if no other value is available efficiently. Do not use this for testing for presence of messages, use hasMessages instead.