Packages

c

org.apache.pekko.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
Type Hierarchy
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. Protected

Instance Constructors

  1. new BoundedNodeMessageQueue(capacity: Int)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from BoundedNodeMessageQueue toany2stringadd[BoundedNodeMessageQueue] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BoundedNodeMessageQueue, B)
    Implicit
    This member is added by an implicit conversion from BoundedNodeMessageQueue toArrowAssoc[BoundedNodeMessageQueue] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def add(value: Envelope): Boolean
    Definition Classes
    AbstractBoundedNodeQueue
  7. final def addNode(n: Node[Envelope]): Boolean
    Definition Classes
    AbstractBoundedNodeQueue
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. final def capacity(): Int

    returns

    the maximum capacity of this queue

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

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

    Definition Classes
    BoundedNodeMessageQueueMessageQueue
    Annotations
    @tailrec()
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  12. 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
    BoundedNodeMessageQueueMessageQueue
  13. 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
    BoundedNodeMessageQueueMessageQueue
  14. def ensuring(cond: (BoundedNodeMessageQueue) => Boolean, msg: => Any): BoundedNodeMessageQueue
    Implicit
    This member is added by an implicit conversion from BoundedNodeMessageQueue toEnsuring[BoundedNodeMessageQueue] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: (BoundedNodeMessageQueue) => Boolean): BoundedNodeMessageQueue
    Implicit
    This member is added by an implicit conversion from BoundedNodeMessageQueue toEnsuring[BoundedNodeMessageQueue] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean, msg: => Any): BoundedNodeMessageQueue
    Implicit
    This member is added by an implicit conversion from BoundedNodeMessageQueue toEnsuring[BoundedNodeMessageQueue] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean): BoundedNodeMessageQueue
    Implicit
    This member is added by an implicit conversion from BoundedNodeMessageQueue toEnsuring[BoundedNodeMessageQueue] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. final def hasMessages: Boolean

    Indicates whether this queue is non-empty.

    Indicates whether this queue is non-empty.

    Definition Classes
    BoundedNodeMessageQueueMessageQueue
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. final def isEmpty(): Boolean
    Definition Classes
    AbstractBoundedNodeQueue
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  28. 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
    BoundedNodeMessageQueueMessageQueue
  29. final def peek(): Envelope

    returns

    the first value of this queue, null if empty

    Definition Classes
    AbstractBoundedNodeQueue
  30. final def peekNode(): Node[Envelope]
    Attributes
    protected[dispatch]
    Definition Classes
    AbstractBoundedNodeQueue
  31. 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
  32. 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
  33. final def pushTimeOut: Duration
  34. 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
  35. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  36. def toString(): String
    Definition Classes
    AnyRef → Any
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from BoundedNodeMessageQueue toStringFormat[BoundedNodeMessageQueue] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (BoundedNodeMessageQueue, B)
    Implicit
    This member is added by an implicit conversion from BoundedNodeMessageQueue toArrowAssoc[BoundedNodeMessageQueue] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from MessageQueue

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromBoundedNodeMessageQueue to any2stringadd[BoundedNodeMessageQueue]

Inherited by implicit conversion StringFormat fromBoundedNodeMessageQueue to StringFormat[BoundedNodeMessageQueue]

Inherited by implicit conversion Ensuring fromBoundedNodeMessageQueue to Ensuring[BoundedNodeMessageQueue]

Inherited by implicit conversion ArrowAssoc fromBoundedNodeMessageQueue to ArrowAssoc[BoundedNodeMessageQueue]

Ungrouped