Packages

c

akka.dispatch

BoundedNodeMessageQueue

class BoundedNodeMessageQueue extends AbstractBoundedNodeQueue[Envelope] with MessageQueue with BoundedMessageQueueSemantics with MultipleConsumerSemantics

Lock-free bounded non-blocking multiple-producer single-consumer queue. Discards overflowing messages into DeadLetters.

Source
Mailbox.scala
Linear Supertypes
MultipleConsumerSemantics, BoundedMessageQueueSemantics, MessageQueue, AbstractBoundedNodeQueue[Envelope], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BoundedNodeMessageQueue
  2. MultipleConsumerSemantics
  3. BoundedMessageQueueSemantics
  4. MessageQueue
  5. AbstractBoundedNodeQueue
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BoundedNodeMessageQueue(capacity: Int)

Value Members

  1. final def add(value: Envelope): Boolean
    Definition Classes
    AbstractBoundedNodeQueue
  2. final def addNode(n: Node[Envelope]): Boolean
    Definition Classes
    AbstractBoundedNodeQueue
  3. final def capacity(): Int

    returns

    the maximum capacity of this queue

    Definition Classes
    AbstractBoundedNodeQueue
  4. final 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.

    Definition Classes
    BoundedNodeMessageQueue → MessageQueue
    Annotations
    @tailrec()
  5. final def dequeue(): Envelope

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

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

    Definition Classes
    BoundedNodeMessageQueue → MessageQueue
  6. final def enqueue(receiver: ActorRef, handle: Envelope): Unit

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

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

    Definition Classes
    BoundedNodeMessageQueue → MessageQueue
  7. final def hasMessages: Boolean

    Indicates whether this queue is non-empty.

    Indicates whether this queue is non-empty.

    Definition Classes
    BoundedNodeMessageQueue → MessageQueue
  8. final def isEmpty(): Boolean
    Definition Classes
    AbstractBoundedNodeQueue
  9. final 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.

    Definition Classes
    BoundedNodeMessageQueue → MessageQueue
  10. final def peek(): Envelope

    returns

    the first value of this queue, null if empty

    Definition Classes
    AbstractBoundedNodeQueue
  11. final def poll(): Envelope

    Removes the first element of this queue if any

    Removes the first element of this queue if any

    returns

    the value of the first element of the queue, null if empty

    Definition Classes
    AbstractBoundedNodeQueue
  12. final def pollNode(): Node[Envelope]

    Removes the first element of this queue if any

    Removes the first element of this queue if any

    returns

    the Node of the first element of the queue, null if empty

    Definition Classes
    AbstractBoundedNodeQueue
  13. final def pushTimeOut: Duration
    Definition Classes
    BoundedNodeMessageQueue → BoundedMessageQueueSemantics
  14. final def size(): Int

    Returns an approximation of the queue's "current" size

    Returns an approximation of the queue's "current" size

    Definition Classes
    AbstractBoundedNodeQueue