Package akka.dispatch

Class NodeMessageQueue

    • Method Summary

      All Methods Instance Methods Concrete 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.
      • Methods inherited from class java.util.concurrent.atomic.AtomicReference

        accumulateAndGet, compareAndExchange, compareAndExchangeAcquire, compareAndExchangeRelease, compareAndSet, get, getAcquire, getAndAccumulate, getAndSet, getAndUpdate, getOpaque, getPlain, lazySet, set, setOpaque, setPlain, setRelease, toString, updateAndGet, weakCompareAndSet, weakCompareAndSetAcquire, weakCompareAndSetPlain, weakCompareAndSetRelease, weakCompareAndSetVolatile
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • NodeMessageQueue

        public NodeMessageQueue()
    • Method Detail

      • cleanUp

        public final void cleanUp​(ActorRef owner,
                                  MessageQueue deadLetters)
        Description copied from interface: MessageQueue
        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.
        Specified by:
        cleanUp in interface MessageQueue
        Parameters:
        owner - (undocumented)
        deadLetters - (undocumented)
      • dequeue

        public final Envelope dequeue()
        Description copied from interface: MessageQueue
        Try to dequeue the next message from this queue, return null failing that.
        Specified by:
        dequeue in interface MessageQueue
        Returns:
        (undocumented)
      • enqueue

        public final void enqueue​(ActorRef receiver,
                                  Envelope handle)
        Description copied from interface: MessageQueue
        Try to enqueue the message to this queue, or throw an exception.
        Specified by:
        enqueue in interface MessageQueue
        Parameters:
        receiver - (undocumented)
        handle - (undocumented)
      • hasMessages

        public final boolean hasMessages()
        Description copied from interface: MessageQueue
        Indicates whether this queue is non-empty.
        Specified by:
        hasMessages in interface MessageQueue
        Returns:
        (undocumented)
      • numberOfMessages

        public final int numberOfMessages()
        Description copied from interface: MessageQueue
        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.
        Specified by:
        numberOfMessages in interface MessageQueue
        Returns:
        (undocumented)