Package akka.dispatch

Interface MessageQueue

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void cleanUp​(ActorRef owner, MessageQueue deadLetters)
      Called when the mailbox this queue belongs to is disposed of.
      Envelope dequeue()
      Try to dequeue the next message from this queue, return null failing that.
      void enqueue​(ActorRef receiver, Envelope handle)
      Try to enqueue the message to this queue, or throw an exception.
      boolean hasMessages()
      Indicates whether this queue is non-empty.
      int numberOfMessages()
      Should return the current number of messages held in this queue; may always return 0 if no other value is available efficiently.
    • Method Detail

      • cleanUp

        void cleanUp​(ActorRef owner,
                     MessageQueue deadLetters)
        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.
        Parameters:
        owner - (undocumented)
        deadLetters - (undocumented)
      • dequeue

        Envelope dequeue()
        Try to dequeue the next message from this queue, return null failing that.
        Returns:
        (undocumented)
      • enqueue

        void enqueue​(ActorRef receiver,
                     Envelope handle)
        Try to enqueue the message to this queue, or throw an exception.
        Parameters:
        receiver - (undocumented)
        handle - (undocumented)
      • hasMessages

        boolean hasMessages()
        Indicates whether this queue is non-empty.
        Returns:
        (undocumented)
      • numberOfMessages

        int numberOfMessages()
        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.
        Returns:
        (undocumented)