ControlAwareMessageQueueSemantics

All Superinterfaces:: MessageQueue, MultipleConsumerSemantics, QueueBasedMessageQueue

All Known Subinterfaces:: BoundedControlAwareMessageQueueSemantics, UnboundedControlAwareMessageQueueSemantics

All Known Implementing Classes:: BoundedControlAwareMailbox.MessageQueue, UnboundedControlAwareMailbox.MessageQueue

public interface ControlAwareMessageQueueSemantics extends QueueBasedMessageQueue

ControlAwareMessageQueue handles messages that extend pekko.dispatch.ControlMessage with priority.

Method Summary

Modifier and Type

Method

Description

Queue<Envelope>

controlQueue()

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.

Queue<Envelope>

queue()

Methods inherited from interface org.apache.pekko.dispatch.QueueBasedMessageQueue
cleanUp

Method Details
- controlQueue
  
  Queue<Envelope> controlQueue()
- dequeue
  
  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
- enqueue
  
  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
- hasMessages
  
  boolean hasMessages()
  
  Description copied from interface: MessageQueue
  
  Indicates whether this queue is non-empty.
  
  Specified by:
  
  hasMessages in interface MessageQueue
  
  Specified by:
  
  hasMessages in interface QueueBasedMessageQueue
- numberOfMessages
  
  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
  
  Specified by:
  
  numberOfMessages in interface QueueBasedMessageQueue
- queue
  
  Queue<Envelope> queue()
  
  Specified by:
  
  queue in interface QueueBasedMessageQueue