#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 | |
| ACE_Message_Queue (size_t high_water_mark=ACE_Message_Queue_Base::DEFAULT_HWM, size_t low_water_mark=ACE_Message_Queue_Base::DEFAULT_LWM, ACE_Notification_Strategy *=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 *=0) |
| virtual int | close (void) |
| virtual | ~ACE_Message_Queue (void) |
| Release all resources from the message queue and mark it as deactivated. | |
| virtual int | flush (void) |
| virtual int | flush_i (void) |
| 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 following <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) |
| 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) |
| 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) |
| virtual int | deactivate (void) |
| virtual int | activate (void) |
| virtual int | pulse (void) |
| virtual int | state (void) |
| virtual int | deactivated (void) |
| virtual int | notify (void) |
| virtual ACE_Notification_Strategy * | notification_strategy (void) |
| Get the notification strategy for the <message_queue>. | |
| virtual void | notification_strategy (ACE_Notification_Strategy *s) |
| Set the notification strategy for the <message_queue>. | |
| 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. | |
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> |
An <ace_message_queue> is the central queueing facility for messages in the ACE framework. If <ace_synch_decl> is <ace_mt_synch> then all operations are thread-safe. Otherwise, if it's <ace_null_synch> then there's no locking overhead.
|
|||||
|
|
|
|||||
|
|
|
||||||||||||||||||||
|
Initialize an <ace_message_queue>. The <high_water_mark> determines how many bytes can be stored in a queue before it's considered "full." Supplier threads must block until the queue is no longer full. The <low_water_mark> determines how many bytes must be in the queue before supplier threads are allowed to enqueue additional <ace_message_block>s. By default, the <high_water_mark> equals the <low_water_mark>, which means that suppliers will be able to enqueue new messages as soon as a consumer removes any message from the queue. Making the <low_water_mark> smaller than the <high_water_mark> forces consumers to drain more messages from the queue before suppliers can enqueue new messages, which can minimize the "silly window syndrome." |
|
||||||||||
|
Release all resources from the message queue and mark it as 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.
|
|
||||||||||
|
Release all resources from the message queue and mark it as deactivated. Returns the number of messages released from the queue. Implements ACE_Message_Queue_Base. |
|
||||||||||
|
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 <errno> == ESHUTDOWN. Returns WAS_INACTIVE if queue was inactive before the call and WAS_ACTIVE if queue was active before the call. 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.
|
|
||||||||||
|
Returns true if the state of the queue is <deactivated>, but false if the queue's is <activated> or <pulsed>. Implements ACE_Message_Queue_Base. |
|
||||||||||||||||
|
This method is an alias for the following <dequeue_head> method.
Implements ACE_Message_Queue_Base. |
|
||||||||||||||||
|
Dequeue and return the <ACE_Message_Block *> with the lowest deadline time. Note that <timeout> uses <{absolute}> time rather than <{relative}> time. If the <timeout> elapses without receiving a message -1 is returned and <errno> is set to <ewouldblock>. If the queue is deactivated -1 is returned and <errno> is set to <eshutdown>. Otherwise, returns -1 on failure, else the number of items still on the queue. |
|
||||||||||
|
Dequeue and return the <ACE_Message_Block *> with the lowest deadline time. |
|
||||||||||||||||
|
Dequeue and return the <ACE_Message_Block *> at the head of the queue. Note that <timeout> uses <{absolute}> time rather than <{relative}> time. If the <timeout> elapses without receiving a message -1 is returned and <errno> is set to <ewouldblock>. If the queue is deactivated -1 is returned and <errno> is set to <eshutdown>. Otherwise, returns -1 on failure, else the number of items still on the queue. Implements ACE_Message_Queue_Base. Reimplemented in ACE_Dynamic_Message_Queue<>. |
|
||||||||||
|
Dequeue and return the <ACE_Message_Block *> at the head of the queue. Reimplemented in ACE_Dynamic_Message_Queue<>. |
|
||||||||||||||||
|
Dequeue and return earliest the <ACE_Message_Block *> that has the lowest priority (i.e., preserves FIFO order for messages with the same priority). Note that <timeout> uses <{absolute}> time rather than <{relative}> time. If the <timeout> elapses without receiving a message -1 is returned and <errno> is set to <ewouldblock>. If the queue is deactivated -1 is returned and <errno> is set to <eshutdown>. Otherwise, returns -1 on failure, else the number of items still on the queue. |
|
||||||||||
|
Dequeue and return the <ACE_Message_Block *> with the lowest priority. |
|
||||||||||||||||
|
Dequeue and return the <ACE_Message_Block *> at the tail of the queue. Note that <timeout> uses <{absolute}> time rather than <{relative}> time. If the <timeout> elapses without receiving a message -1 is returned and <errno> is set to <ewouldblock>. If the queue is deactivated -1 is returned and <errno> is set to <eshutdown>. Otherwise, returns -1 on failure, else the number of items still on the queue. |
|
||||||||||
|
Dequeue and return the <ACE_Message_Block *> at the tail of the queue. |
|
||||||||||
|
Dump the state of an object.
Implements ACE_Message_Queue_Base. Reimplemented in ACE_Dynamic_Message_Queue<>. |
|
||||||||||||||||
|
This is an alias for <enqueue_prio>. It's only here for backwards compatibility and will go away in a subsequent release. Please use <enqueue_prio> instead. Note that <timeout> uses <{absolute}> time rather than <{relative}> time. Implements ACE_Message_Queue_Base. |
|
||||||||||||||||
|
Enqueue an <ACE_Message_Block *> into the <message_queue> in accordance with its <msg_deadline_time>. FIFO order is maintained when messages of the same deadline time are inserted consecutively. Note that <timeout> uses <{absolute}> time rather than <{relative}> time. If the <timeout> elapses without receiving a message -1 is returned and <errno> is set to <ewouldblock>. If the queue is deactivated -1 is returned and <errno> is set to <eshutdown>. Otherwise, returns -1 on failure, else the number of items still on the queue. |
|
||||||||||
|
Enqueue an <ACE_Message_Block *> in accordance with its deadline time.
|
|
||||||||||||||||
|
Enqueue an <ACE_Message_Block *> at the head of the queue. Note that <timeout> uses <{absolute}> time rather than <{relative}> time. If the <timeout> elapses without receiving a message -1 is returned and <errno> is set to <ewouldblock>. If the queue is deactivated -1 is returned and <errno> is set to <eshutdown>. Otherwise, returns -1 on failure, else the number of items still on the queue. Reimplemented in ACE_Dynamic_Message_Queue<>. |
|
||||||||||
|
Enqueue an <ACE_Message_Block *> at the head of the queue.
|
|
||||||||||
|
Enqueue an <ACE_Message_Block *> in accordance with its priority.
Reimplemented in ACE_Dynamic_Message_Queue<>. |
|
||||||||||||||||
|
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.
|
|
||||||||||||||||
|
Enqueue an <ACE_Message_Block *> at the end of the queue. Note that <timeout> uses <{absolute}> time rather than <{relative}> time. If the <timeout> elapses without receiving a message -1 is returned and <errno> is set to <ewouldblock>. If the queue is deactivated -1 is returned and <errno> is set to <eshutdown>. Otherwise, returns -1 on failure, else the number of items still on the queue. Implements ACE_Message_Queue_Base. Reimplemented in ACE_Dynamic_Message_Queue<>. |
|
||||||||||
|
Enqueue an <ACE_Message_Block *> at the end of the queue.
|
|
||||||||||
|
This method holds the queue lock during this operation.
|
|
||||||||||
|
The caller must be holding the queue lock before calling this method.
|
|
||||||||||
|
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.
|
|
||||||||||
|
True if queue is full, else false.
Implements ACE_Message_Queue_Base. |
|
||||||||||
|
True if queue is full, else false.
|
|
||||||||||
|
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_block>s. |
|
||||||||||
|
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 <message_queue>.
Implements ACE_Message_Queue_Base. |
|
||||||||||
|
Get the notification strategy for the <message_queue>.
Implements ACE_Message_Queue_Base. |
|
||||||||||
|
This hook is automatically invoked by <enqueue_head>, <enqueue_tail>, and <enqueue_prio> 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 <wfmo_reactor>, notifying a <reactor>, 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. |
|
||||||||||||||||||||
|
Initialize an <ace_message_queue>. The <high_water_mark> determines how many bytes can be stored in a queue before it's considered "full." Supplier threads must block until the queue is no longer full. The <low_water_mark> determines how many bytes must be in the queue before supplier threads are allowed to enqueue additional <ace_message_block>s. By default, the <high_water_mark> equals the <low_water_mark>, which means that suppliers will be able to enqueue new messages as soon as a consumer removes any message from the queue. Making the <low_water_mark> smaller than the <high_water_mark> forces consumers to drain more messages from the queue before suppliers can enqueue new messages, which can minimize the "silly window syndrome." |
|
||||||||||
|
|
|
||||||||||||||||
|
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<>. |
|
||||||||||
|
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.
|
|
||||||||||
|
Inform any threads waiting to enqueue that they can procede.
|
|
||||||||||
|
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.
|
|
||||||||||||||||
|
Wait for the queue to become non-full.
|
|
|||||
|
|
|
|||||
|
|
|
|||||
|
Declare the dynamic allocation hooks.
Reimplemented from ACE_Message_Queue_Base. Reimplemented in ACE_Dynamic_Message_Queue<>. |
|
|||||
|
Current number of bytes in the queue.
|
|
|||||
|
Current number of messages in the queue.
|
|
|||||
|
Current length of messages in the queue.
|
|
|||||
|
Pointer to head of ACE_Message_Block list.
|
|
|||||
|
Greatest number of bytes before blocking.
|
|
|||||
|
Protect queue from concurrent access.
|
|
|||||
|
Lowest number before unblocking occurs.
|
|
|||||
|
Used to make threads sleep until the queue is no longer empty.
|
|
|||||
|
Used to make threads sleep until the queue is no longer full.
|
|
|||||
|
The notification strategy used when a new message is enqueued.
|
|
|||||
|
Pointer to tail of ACE_Message_Block list.
|
1.3.9.1