#include <Message_Queue_T.h>
Inheritance diagram for ACE_Message_Queue_Ex_N< ACE_MESSAGE_TYPE, >:
Public Member Functions | |
ACE_Message_Queue_Ex_N (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 *ns=0) | |
virtual | ~ACE_Message_Queue_Ex_N (void) |
Close down the message queue and release all resources. | |
virtual int | enqueue_head (ACE_MESSAGE_TYPE *new_item, ACE_Time_Value *tv=0) |
virtual int | enqueue_tail (ACE_MESSAGE_TYPE *new_item, ACE_Time_Value *tv=0) |
Public Attributes | |
ACE_ALLOC_HOOK_DECLARE | |
Declare the dynamic allocation hooks. | |
Protected Member Functions | |
ACE_Message_Block * | wrap_with_mbs_i (ACE_MESSAGE_TYPE *new_item) |
As ACE_Message_Queue_Ex, ACE_Message_Queue_Ex_N is a strongly-typed version of the ACE_Message_Queue. 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.
The ACE_MESSAGE_TYPE
messages that are sent to this queue can be chained. Messages are expected to have a next
method that returns the next message in the chain; ACE_Message_Queue_Ex_N uses this method to run through all the incoming messages and enqueue them in one call.
Definition at line 1400 of file Message_Queue_T.h.
ACE_Message_Queue_Ex_N< ACE_MESSAGE_TYPE, >::ACE_Message_Queue_Ex_N | ( | 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 * | ns = 0 | |||
) |
Initialize an ACE_Message_Queue_Ex_N. 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 messages. 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."
Definition at line 343 of file Message_Queue_T.cpp.
References ACE_TRACE.
00345 : 00346 ACE_Message_Queue_Ex<ACE_MESSAGE_TYPE, ACE_SYNCH_USE> (high_water_mark, 00347 low_water_mark, 00348 ns) 00349 { 00350 ACE_TRACE ("ACE_Message_Queue_Ex_N<ACE_MESSAGE_TYPE, ACE_SYNCH_USE>::ACE_Message_Queue_Ex_N"); 00351 }
ACE_Message_Queue_Ex_N< ACE_MESSAGE_TYPE, >::~ACE_Message_Queue_Ex_N | ( | void | ) | [virtual] |
Close down the message queue and release all resources.
Definition at line 354 of file Message_Queue_T.cpp.
References ACE_TRACE.
00355 { 00356 ACE_TRACE ("ACE_Message_Queue_Ex_N<ACE_MESSAGE_TYPE, ACE_SYNCH_USE>::~ACE_Message_Queue_Ex_N"); 00357 }
int ACE_Message_Queue_Ex_N< ACE_MESSAGE_TYPE, >::enqueue_head | ( | ACE_MESSAGE_TYPE * | new_item, | |
ACE_Time_Value * | tv = 0 | |||
) | [virtual] |
Enqueue one or more ACE_MESSAGE_TYPE
objects at the head of the queue. If the new_item next()
pointer is non-zero, it is assumed to be the start of a series of ACE_MESSAGE_TYPE
objects connected via their next()
pointers. The series of blocks will be added to the queue in the same order they are passed in as.
new_item | Pointer to an ACE_MESSAGE_TYPE that will be added to the queue. If the block's next() pointer is non-zero, all blocks chained from the next() pointer are enqueued as well. | |
tv | The absolute time the caller will wait until for the block to be queued. |
>0 | The number of ACE_MESSAGE_TYPE objects on the queue after adding the specified block(s). | |
-1 | On failure. errno holds the reason. Common errno values are:
|
Reimplemented from ACE_Message_Queue_Ex< ACE_MESSAGE_TYPE, ACE_SYNCH_USE >.
Definition at line 361 of file Message_Queue_T.cpp.
References ACE_TRACE, and ACE_Message_Block::release().
00363 { 00364 ACE_TRACE ("ACE_Message_Queue_Ex_N<ACE_MESSAGE_TYPE, ACE_SYNCH_USE>::enqueue_head"); 00365 00366 // Create a chained ACE_Message_Blocks wrappers around the 'chained' 00367 // ACE_MESSAGE_TYPES. 00368 ACE_Message_Block *mb = this->wrap_with_mbs_i (new_item); 00369 if (0 == mb) 00370 { 00371 return -1; 00372 } 00373 00374 int result = this->queue_.enqueue_head (mb, timeout); 00375 if (-1 == result) 00376 { 00377 // Zap the messages. 00378 mb->release (); 00379 } 00380 return result; 00381 }
int ACE_Message_Queue_Ex_N< ACE_MESSAGE_TYPE, >::enqueue_tail | ( | ACE_MESSAGE_TYPE * | new_item, | |
ACE_Time_Value * | tv = 0 | |||
) | [virtual] |
Enqueue one or more ACE_MESSAGE_TYPE
objects at the tail of the queue. If the new_item next()
pointer is non-zero, it is assumed to be the start of a series of ACE_MESSAGE_TYPE
objects connected via their next()
pointers. The series of blocks will be added to the queue in the same order they are passed in as.
new_item | Pointer to an ACE_MESSAGE_TYPE that will be added to the queue. If the block's next() pointer is non-zero, all blocks chained from the next() pointer are enqueued as well. | |
tv | The absolute time the caller will wait until for the block to be queued. |
>0 | The number of ACE_MESSAGE_TYPE objects on the queue after adding the specified block(s). | |
-1 | On failure. errno holds the reason. Common errno values are:
|
Reimplemented from ACE_Message_Queue_Ex< ACE_MESSAGE_TYPE, ACE_SYNCH_USE >.
Definition at line 385 of file Message_Queue_T.cpp.
References ACE_TRACE, and ACE_Message_Block::release().
00387 { 00388 ACE_TRACE ("ACE_Message_Queue_Ex_N<ACE_MESSAGE_TYPE, ACE_SYNCH_USE>::enqueue_tail"); 00389 00390 // Create a chained ACE_Message_Blocks wrappers around the 'chained' 00391 // ACE_MESSAGE_TYPES. 00392 ACE_Message_Block *mb = this->wrap_with_mbs_i (new_item); 00393 if (0 == mb) 00394 { 00395 return -1; 00396 } 00397 00398 int result = this->queue_.enqueue_tail (mb, timeout); 00399 if (-1 == result) 00400 { 00401 // Zap the message. 00402 mb->release (); 00403 } 00404 return result; 00405 }
ACE_Message_Block * ACE_Message_Queue_Ex_N< ACE_MESSAGE_TYPE, >::wrap_with_mbs_i | ( | ACE_MESSAGE_TYPE * | new_item | ) | [protected] |
An helper method that wraps the incoming chain messages with ACE_Message_Blocks.
Definition at line 409 of file Message_Queue_T.cpp.
References ACE_NEW_NORETURN, ACE_NEW_RETURN, ACE_TRACE, ACE_Message_Block::next(), and ACE_Message_Block::release().
00410 { 00411 ACE_TRACE ("ACE_Message_Queue_Ex_N<ACE_MESSAGE_TYPE, ACE_SYNCH_USE>::wrap_with_mbs_i"); 00412 00413 // We need to keep a reference to the head of the chain 00414 ACE_Message_Block *mb_head = 0; 00415 00416 ACE_NEW_RETURN (mb_head, 00417 ACE_Message_Block ((char *) new_item, 00418 sizeof (*new_item), 00419 ACE_Message_Queue_Ex<ACE_MESSAGE_TYPE, ACE_SYNCH_USE>::DEFAULT_PRIORITY), 00420 0); 00421 00422 // mb_tail will point to the last ACE_Message_Block 00423 ACE_Message_Block *mb_tail = mb_head; 00424 00425 // Run through rest of the messages and wrap them 00426 for (ACE_MESSAGE_TYPE *pobj = new_item->next (); pobj; pobj = pobj->next ()) 00427 { 00428 ACE_Message_Block *mb_temp = 0; 00429 ACE_NEW_NORETURN (mb_temp, 00430 ACE_Message_Block ((char *) pobj, 00431 sizeof (*pobj), 00432 ACE_Message_Queue_Ex<ACE_MESSAGE_TYPE, ACE_SYNCH_USE>::DEFAULT_PRIORITY)); 00433 if (mb_temp == 0) 00434 { 00435 mb_head->release (); 00436 mb_head = 0; 00437 break; 00438 } 00439 00440 mb_tail->next (mb_temp); 00441 mb_tail = mb_temp; 00442 } 00443 00444 return mb_head; 00445 }
ACE_Message_Queue_Ex_N< ACE_MESSAGE_TYPE, >::ACE_ALLOC_HOOK_DECLARE |
Declare the dynamic allocation hooks.
Reimplemented from ACE_Message_Queue_Ex< ACE_MESSAGE_TYPE, ACE_SYNCH_USE >.
Definition at line 1471 of file Message_Queue_T.h.