#include <Message_Queue_T.h>
Inheritance diagram for ACE_Message_Queue<>:
Public Types | |
typedef ACE_Message_Queue_Iterator< ACE_SYNCH_USE > | ITERATOR |
typedef ACE_Message_Queue_Reverse_Iterator< ACE_SYNCH_USE > | REVERSE_ITERATOR |
Public Member Functions | |
virtual int | close (void) |
virtual | ~ACE_Message_Queue (void) |
Releases all resources from the message queue and marks it deactivated. | |
virtual int | flush (void) |
virtual int | flush_i (void) |
virtual ACE_SYNCH_MUTEX_T & | lock (void) |
Returns a reference to the lock used by the ACE_Message_Queue. | |
virtual void | dump (void) const |
Dump the state of an object. | |
Initialization methods | |
ACE_Message_Queue (size_t hwm=ACE_Message_Queue_Base::DEFAULT_HWM, size_t lwm=ACE_Message_Queue_Base::DEFAULT_LWM, ACE_Notification_Strategy *ns=0) | |
virtual int | open (size_t hwm=ACE_Message_Queue_Base::DEFAULT_HWM, size_t lwm=ACE_Message_Queue_Base::DEFAULT_LWM, ACE_Notification_Strategy *ns=0) |
Enqueue and dequeue methods | |
The enqueue and dequeue methods accept a timeout value passed as an ACE_Time_Value *. In all cases, if the timeout pointer is 0, the caller will block until action is possible. If the timeout pointer is non-zero, the call will wait (if needed, subject to water mark settings) until the absolute time specified in the referenced ACE_Time_Value object is reached. If the time is reached before the desired action is possible, the method will return -1 with errno set to EWOULDBLOCK . Regardless of the timeout setting, however, these methods will also fail and return -1 when the queue is closed, deactivated, pulsed, or when a signal occurs.
See C++NPv2 Section 6.2 and APG Section 12.3 for a fuller treatment of ACE_Message_Queue, enqueueing, dequeueing, and how these operations are affected by queue state transitions. | |
virtual int | peek_dequeue_head (ACE_Message_Block *&first_item, ACE_Time_Value *timeout=0) |
virtual int | enqueue_prio (ACE_Message_Block *new_item, ACE_Time_Value *timeout=0) |
virtual int | enqueue_deadline (ACE_Message_Block *new_item, ACE_Time_Value *timeout=0) |
virtual int | enqueue (ACE_Message_Block *new_item, ACE_Time_Value *timeout=0) |
virtual int | enqueue_tail (ACE_Message_Block *new_item, ACE_Time_Value *timeout=0) |
virtual int | enqueue_head (ACE_Message_Block *new_item, ACE_Time_Value *timeout=0) |
virtual int | dequeue (ACE_Message_Block *&first_item, ACE_Time_Value *timeout=0) |
This method is an alias for the dequeue_head() method. | |
virtual int | dequeue_head (ACE_Message_Block *&first_item, ACE_Time_Value *timeout=0) |
virtual int | dequeue_prio (ACE_Message_Block *&first_item, ACE_Time_Value *timeout=0) |
virtual int | dequeue_tail (ACE_Message_Block *&dequeued, ACE_Time_Value *timeout=0) |
virtual int | dequeue_deadline (ACE_Message_Block *&dequeued, ACE_Time_Value *timeout=0) |
Queue statistics methods | |
virtual int | is_full (void) |
True if queue is full, else false. | |
virtual int | is_empty (void) |
True if queue is empty, else false. | |
virtual size_t | message_bytes (void) |
virtual size_t | message_length (void) |
virtual size_t | message_count (void) |
virtual void | message_bytes (size_t new_size) |
virtual void | message_length (size_t new_length) |
Water mark (flow control) methods | |
virtual size_t | high_water_mark (void) |
virtual void | high_water_mark (size_t hwm) |
virtual size_t | low_water_mark (void) |
virtual void | low_water_mark (size_t lwm) |
Activation and queue state methods | |
See C++NPv2 Section 6.2 and APG Section 12.3 for a fuller treatment of queue states and transitions and how the transitions affect message enqueueing and dequeueing operations. | |
virtual int | deactivate (void) |
virtual int | activate (void) |
virtual int | pulse (void) |
virtual int | state (void) |
virtual int | deactivated (void) |
Notification strategy methods | |
virtual int | notify (void) |
virtual ACE_Notification_Strategy * | notification_strategy (void) |
Get the notification strategy for the . | |
virtual void | notification_strategy (ACE_Notification_Strategy *s) |
Set the notification strategy for the . | |
Public Attributes | |
ACE_ALLOC_HOOK_DECLARE | |
Declare the dynamic allocation hooks. | |
Protected Member Functions | |
virtual int | enqueue_i (ACE_Message_Block *new_item) |
Enqueue an <ACE_Message_Block *> in accordance with its priority. | |
virtual int | enqueue_deadline_i (ACE_Message_Block *new_item) |
Enqueue an <ACE_Message_Block *> in accordance with its deadline time. | |
virtual int | enqueue_tail_i (ACE_Message_Block *new_item) |
Enqueue an <ACE_Message_Block *> at the end of the queue. | |
virtual int | enqueue_head_i (ACE_Message_Block *new_item) |
Enqueue an <ACE_Message_Block *> at the head of the queue. | |
virtual int | dequeue_head_i (ACE_Message_Block *&first_item) |
virtual int | dequeue_prio_i (ACE_Message_Block *&dequeued) |
virtual int | dequeue_tail_i (ACE_Message_Block *&first_item) |
virtual int | dequeue_deadline_i (ACE_Message_Block *&first_item) |
virtual int | is_full_i (void) |
True if queue is full, else false. | |
virtual int | is_empty_i (void) |
True if queue is empty, else false. | |
virtual int | deactivate_i (int pulse=0) |
virtual int | activate_i (void) |
Activate the queue. | |
virtual int | wait_not_full_cond (ACE_Guard< ACE_SYNCH_MUTEX_T > &mon, ACE_Time_Value *timeout) |
Wait for the queue to become non-full. | |
virtual int | wait_not_empty_cond (ACE_Guard< ACE_SYNCH_MUTEX_T > &mon, ACE_Time_Value *timeout) |
Wait for the queue to become non-empty. | |
virtual int | signal_enqueue_waiters (void) |
Inform any threads waiting to enqueue that they can procede. | |
virtual int | signal_dequeue_waiters (void) |
Inform any threads waiting to dequeue that they can procede. | |
Protected Attributes | |
ACE_Message_Block * | head_ |
Pointer to head of ACE_Message_Block list. | |
ACE_Message_Block * | tail_ |
Pointer to tail of ACE_Message_Block list. | |
size_t | low_water_mark_ |
Lowest number before unblocking occurs. | |
size_t | high_water_mark_ |
Greatest number of bytes before blocking. | |
size_t | cur_bytes_ |
Current number of bytes in the queue. | |
size_t | cur_length_ |
Current length of messages in the queue. | |
size_t | cur_count_ |
Current number of messages in the queue. | |
ACE_Notification_Strategy * | notification_strategy_ |
The notification strategy used when a new message is enqueued. | |
ACE_SYNCH_MUTEX_T | lock_ |
Protect queue from concurrent access. | |
ACE_SYNCH_CONDITION_T | not_empty_cond_ |
Used to make threads sleep until the queue is no longer empty. | |
ACE_SYNCH_CONDITION_T | not_full_cond_ |
Used to make threads sleep until the queue is no longer full. | |
Private Member Functions | |
void | operator= (const ACE_Message_Queue< _ACE_SYNCH > &) |
ACE_Message_Queue (const ACE_Message_Queue< _ACE_SYNCH > &) | |
Friends | |
class | ACE_Message_Queue_Iterator< ACE_SYNCH_USE > |
class | ACE_Message_Queue_Reverse_Iterator< ACE_SYNCH_USE > |
ACE_Message_Queue is the primary queueing facility for messages in the ACE framework. It's one template argument parameterizes the queue's synchronization. The argument specifies a synchronization strategy. The two main strategies available for ACE_SYNCH_DECL are:
All data passing through ACE_Message_Queue is in the form of ACE_Message_Block objects.
Definition at line 53 of file Message_Queue_T.h.
|
Definition at line 61 of file Message_Queue_T.h. |
|
Definition at line 63 of file Message_Queue_T.h. |
|
Initialize an ACE_Message_Queue.
|
|
Releases all resources from the message queue and marks it deactivated.
|
|
|
|
Reactivate the queue so that threads can enqueue and dequeue messages again. Returns the state of the queue before the call. Implements ACE_Message_Queue_Base. |
|
Activate the queue.
Referenced by ACE_Message_Queue< ACE_SYNCH_USE >::activate(). |
|
Releases all resources from the message queue and marks it deactivated.
Implements ACE_Message_Queue_Base. Referenced by ACE_Message_Queue< ACE_SYNCH_USE >::~ACE_Message_Queue(). |
|
Deactivate the queue and wakeup all threads waiting on the queue so they can continue. No messages are removed from the queue, however. Any other operations called until the queue is activated again will immediately return -1 with Implements ACE_Message_Queue_Base. |
|
Notifies all waiting threads that the queue has been deactivated so they can wakeup and continue other processing. No messages are removed from the queue.
Referenced by ACE_Message_Queue< ACE_SYNCH_USE >::close(), ACE_Message_Queue< ACE_SYNCH_USE >::deactivate(), and ACE_Message_Queue< ACE_SYNCH_USE >::pulse(). |
|
Returns true if the state of the queue is , but false if the queue's is or . Implements ACE_Message_Queue_Base. |
|
This method is an alias for the dequeue_head() method.
Implements ACE_Message_Queue_Base. |
|
Dequeue the ACE_Message_Block with the earliest deadline time and return a pointer to the dequeued block.
|
|
Dequeue and return the <ACE_Message_Block *> with the lowest deadline time. Referenced by ACE_Message_Queue< ACE_SYNCH_USE >::dequeue_deadline(). |
|
Dequeue the ACE_Message_Block at the head of the queue and return a pointer to the dequeued block.
Implements ACE_Message_Queue_Base. Reimplemented in ACE_Dynamic_Message_Queue<>. Referenced by ACE_Message_Queue< ACE_SYNCH_USE >::dequeue(). |
|
Dequeue and return the <ACE_Message_Block *> at the head of the queue. Reimplemented in ACE_Dynamic_Message_Queue<>. Referenced by ACE_Message_Queue< ACE_SYNCH_USE >::dequeue_deadline_i(), and ACE_Message_Queue< ACE_SYNCH_USE >::dequeue_head(). |
|
Dequeue the ACE_Message_Block that has the lowest priority (preserves FIFO order for messages with the same priority) and return a pointer to the dequeued block.
|
|
Dequeue and return the <ACE_Message_Block *> with the lowest priority. Referenced by ACE_Message_Queue< ACE_SYNCH_USE >::dequeue_prio(). |
|
Dequeue the ACE_Message_Block at the tail of the queue and return a pointer to the dequeued block.
|
|
Dequeue and return the <ACE_Message_Block *> at the tail of the queue. Referenced by ACE_Message_Queue< ACE_SYNCH_USE >::dequeue_tail(). |
|
Dump the state of an object.
Implements ACE_Message_Queue_Base. Reimplemented in ACE_Dynamic_Message_Queue<>. Referenced by ACE_Dynamic_Message_Queue<>::dump(). |
|
Implements ACE_Message_Queue_Base. |
|
Enqueue an ACE_Message_Block into the queue in accordance with the block's deadline time. FIFO order is maintained when messages of the same deadline time are inserted consecutively.
|
|
Enqueue an <ACE_Message_Block *> in accordance with its deadline time.
Referenced by ACE_Message_Queue< ACE_SYNCH_USE >::enqueue_deadline(). |
|
Enqueue one or more ACE_Message_Block objects at the head of the queue. If the new_item
Reimplemented in ACE_Dynamic_Message_Queue<>. |
|
Enqueue an <ACE_Message_Block *> at the head of the queue.
Referenced by ACE_Message_Queue< ACE_SYNCH_USE >::enqueue_deadline_i(), ACE_Message_Queue< ACE_SYNCH_USE >::enqueue_head(), and ACE_Message_Queue< ACE_SYNCH_USE >::enqueue_i(). |
|
Enqueue an <ACE_Message_Block *> in accordance with its priority.
Reimplemented in ACE_Dynamic_Message_Queue<>. Referenced by ACE_Message_Queue< ACE_SYNCH_USE >::enqueue_prio(). |
|
Enqueue an ACE_Message_Block into the queue in accordance with the ACE_Message_Block's priority (0 is lowest priority). FIFO order is maintained when messages of the same priority are inserted consecutively.
Referenced by ACE_Message_Queue< ACE_SYNCH_USE >::enqueue(). |
|
Enqueue one or more ACE_Message_Block objects at the tail of the queue. If the new_item
Implements ACE_Message_Queue_Base. Reimplemented in ACE_Dynamic_Message_Queue<>. |
|
Enqueue an <ACE_Message_Block *> at the end of the queue.
Referenced by ACE_Message_Queue< ACE_SYNCH_USE >::enqueue_deadline_i(), ACE_Message_Queue< ACE_SYNCH_USE >::enqueue_i(), and ACE_Message_Queue< ACE_SYNCH_USE >::enqueue_tail(). |
|
Releases all resources from the message queue but does not mark it deactivated. This method holds the queue lock during this operation.
|
|
Release all resources from the message queue but do not mark it as deactivated.
Referenced by ACE_Message_Queue< ACE_SYNCH_USE >::close(), and ACE_Message_Queue< ACE_SYNCH_USE >::flush(). |
|
Set the high watermark, which determines how many bytes can be stored in a queue before it's considered "full." |
|
Get high watermark. |
|
True if queue is empty, else false.
Implements ACE_Message_Queue_Base. |
|
True if queue is empty, else false.
Referenced by ACE_Message_Queue< ACE_SYNCH_USE >::is_empty(). |
|
True if queue is full, else false.
Implements ACE_Message_Queue_Base. |
|
True if queue is full, else false.
Referenced by ACE_Message_Queue< ACE_SYNCH_USE >::is_full(), and ACE_Message_Queue< ACE_SYNCH_USE >::wait_not_full_cond(). |
|
Returns a reference to the lock used by the ACE_Message_Queue.
|
|
Set the low watermark, which determines how many bytes must be in the queue before supplier threads are allowed to enqueue additional ACE_Message_Blocks. |
|
Get low watermark. |
|
New value of the number of total bytes on the queue, i.e., sum of the message block sizes. Implements ACE_Message_Queue_Base. |
|
Number of total bytes on the queue, i.e., sum of the message block sizes. Implements ACE_Message_Queue_Base. |
|
Number of total messages on the queue. Implements ACE_Message_Queue_Base. |
|
New value of the number of total length on the queue, i.e., sum of the message block lengths. Implements ACE_Message_Queue_Base. |
|
Number of total length on the queue, i.e., sum of the message block lengths. Implements ACE_Message_Queue_Base. |
|
Set the notification strategy for the .
Implements ACE_Message_Queue_Base. |
|
Get the notification strategy for the .
Implements ACE_Message_Queue_Base. |
|
This hook is automatically invoked by , , and when a new item is inserted into the queue. Subclasses can override this method to perform specific notification strategies (e.g., signaling events for a , notifying a , etc.). In a multi-threaded application with concurrent consumers, there is no guarantee that the queue will be still be non-empty by the time the notification occurs. Referenced by ACE_Message_Queue< ACE_SYNCH_USE >::enqueue_deadline(), ACE_Message_Queue< ACE_SYNCH_USE >::enqueue_head(), ACE_Message_Queue< ACE_SYNCH_USE >::enqueue_prio(), and ACE_Message_Queue< ACE_SYNCH_USE >::enqueue_tail(). |
|
Initialize an ACE_Message_Queue.
Referenced by ACE_Message_Queue< ACE_SYNCH_USE >::ACE_Message_Queue(). |
|
|
|
Retrieve a pointer to the first ACE_Message_Block in the queue without removing it.
Implements ACE_Message_Queue_Base. Reimplemented in ACE_Dynamic_Message_Queue<>. Referenced by ACE_Dynamic_Message_Queue<>::peek_dequeue_head(). |
|
Pulse the queue to wake up any waiting threads. Changes the queue state to PULSED; future enqueue/dequeue operations proceed as in ACTIVATED state.
Implements ACE_Message_Queue_Base. |
|
Inform any threads waiting to dequeue that they can procede.
Referenced by ACE_Message_Queue< ACE_SYNCH_USE >::enqueue_deadline_i(), ACE_Message_Queue< ACE_SYNCH_USE >::enqueue_head_i(), ACE_Message_Queue< ACE_SYNCH_USE >::enqueue_i(), and ACE_Message_Queue< ACE_SYNCH_USE >::enqueue_tail_i(). |
|
Inform any threads waiting to enqueue that they can procede.
Referenced by ACE_Message_Queue< ACE_SYNCH_USE >::dequeue_deadline_i(), ACE_Message_Queue< ACE_SYNCH_USE >::dequeue_head_i(), ACE_Message_Queue< ACE_SYNCH_USE >::dequeue_prio_i(), and ACE_Message_Queue< ACE_SYNCH_USE >::dequeue_tail_i(). |
|
Returns the current state of the queue, which can be one of ACTIVATED, DEACTIVATED, or PULSED. Reimplemented from ACE_Message_Queue_Base. |
|
Wait for the queue to become non-empty.
Referenced by ACE_Message_Queue< ACE_SYNCH_USE >::dequeue_deadline(), ACE_Message_Queue< ACE_SYNCH_USE >::dequeue_head(), ACE_Message_Queue< ACE_SYNCH_USE >::dequeue_prio(), ACE_Message_Queue< ACE_SYNCH_USE >::dequeue_tail(), and ACE_Message_Queue< ACE_SYNCH_USE >::peek_dequeue_head(). |
|
Wait for the queue to become non-full.
Referenced by ACE_Message_Queue< ACE_SYNCH_USE >::enqueue_deadline(), ACE_Message_Queue< ACE_SYNCH_USE >::enqueue_head(), ACE_Message_Queue< ACE_SYNCH_USE >::enqueue_prio(), and ACE_Message_Queue< ACE_SYNCH_USE >::enqueue_tail(). |
|
Definition at line 56 of file Message_Queue_T.h. |
|
Definition at line 57 of file Message_Queue_T.h. |
|
Declare the dynamic allocation hooks.
Reimplemented from ACE_Message_Queue_Base. Reimplemented in ACE_Dynamic_Message_Queue<>. Definition at line 477 of file Message_Queue_T.h. |
|
Current number of bytes in the queue.
Definition at line 574 of file Message_Queue_T.h. |
|
Current number of messages in the queue.
Definition at line 580 of file Message_Queue_T.h. |
|
Current length of messages in the queue.
Definition at line 577 of file Message_Queue_T.h. |
|
Pointer to head of ACE_Message_Block list.
Definition at line 562 of file Message_Queue_T.h. |
|
Greatest number of bytes before blocking.
Definition at line 571 of file Message_Queue_T.h. |
|
Protect queue from concurrent access.
Definition at line 587 of file Message_Queue_T.h. |
|
Lowest number before unblocking occurs.
Definition at line 568 of file Message_Queue_T.h. |
|
Used to make threads sleep until the queue is no longer empty.
Definition at line 590 of file Message_Queue_T.h. |
|
Used to make threads sleep until the queue is no longer full.
Definition at line 593 of file Message_Queue_T.h. |
|
The notification strategy used when a new message is enqueued.
Definition at line 583 of file Message_Queue_T.h. |
|
Pointer to tail of ACE_Message_Block list.
Definition at line 565 of file Message_Queue_T.h. |