akka.dispatch

MessageQueue

Related Doc: package dispatch

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
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
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
Learn more about member selection
Visibility
  1. Public
  2. All

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.

  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.

Concrete 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 information
    This member is added by an implicit conversion from MessageQueue to any2stringadd[MessageQueue] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (MessageQueue, B)

    Implicit information
    This member is added by an implicit conversion from MessageQueue to ArrowAssoc[MessageQueue] 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 asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (MessageQueue) ⇒ Boolean, msg: ⇒ Any): MessageQueue

    Implicit information
    This member is added by an implicit conversion from MessageQueue to Ensuring[MessageQueue] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (MessageQueue) ⇒ Boolean): MessageQueue

    Implicit information
    This member is added by an implicit conversion from MessageQueue to Ensuring[MessageQueue] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): MessageQueue

    Implicit information
    This member is added by an implicit conversion from MessageQueue to Ensuring[MessageQueue] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): MessageQueue

    Implicit information
    This member is added by an implicit conversion from MessageQueue to Ensuring[MessageQueue] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from MessageQueue to StringFormat[MessageQueue] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  23. def toString(): String

    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def [B](y: B): (MessageQueue, B)

    Implicit information
    This member is added by an implicit conversion from MessageQueue to ArrowAssoc[MessageQueue] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from MessageQueue to any2stringadd[MessageQueue]

Inherited by implicit conversion StringFormat from MessageQueue to StringFormat[MessageQueue]

Inherited by implicit conversion Ensuring from MessageQueue to Ensuring[MessageQueue]

Inherited by implicit conversion ArrowAssoc from MessageQueue to ArrowAssoc[MessageQueue]

Ungrouped