Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

ACE_Message_Queue_Iterator<> Class Template Reference

Iterator for the ACE_Message_Queue. More...

#include <Message_Queue_T.h>

Collaboration diagram for ACE_Message_Queue_Iterator<>:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ACE_Message_Queue_Iterator (ACE_Message_Queue< ACE_SYNCH_USE > &queue)
int next (ACE_Message_Block *&entry)
int done (void) const
 Returns 1 when all items have been seen, else 0.

int advance (void)
void dump (void) const
 Dump the state of an object.


Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks.


Private Attributes

ACE_Message_Queue< ACE_SYNCH_USE > & queue_
 Message_Queue we are iterating over.

ACE_Message_Block * curr_
 Keeps track of how far we've advanced...

Detailed Description

template<ACE_SYNCH_DECL>
class ACE_Message_Queue_Iterator<>

Iterator for the ACE_Message_Queue.

Definition at line 612 of file Message_Queue_T.h.

Constructor & Destructor Documentation

template<ACE_SYNCH_DECL >
ACE_Message_Queue_Iterator<>::ACE_Message_Queue_Iterator (  ACE_Message_Queue< ACE_SYNCH_USE > &  queue  ) 
 

Definition at line 592 of file Message_Queue_T.cpp. 

00593   : queue_ (q),
00594     curr_ (q.head_)
00595 {
00596 }

Member Function Documentation

template<ACE_SYNCH_DECL >
int ACE_Message_Queue_Iterator<>::advance (  void   ) 
 

Move forward by one element in the queue. Returns 0 when all the items in the set have been seen, else 1.

Definition at line 621 of file Message_Queue_T.cpp.

References ACE_READ_GUARD_RETURN, ACE_SYNCH_MUTEX_T, and ACE_Message_Block::next(). 

00622 {
00623   ACE_READ_GUARD_RETURN (ACE_SYNCH_MUTEX_T, m, this->queue_.lock_, -1)
00624 
00625   if (this->curr_)
00626     this->curr_ = this->curr_->next ();
00627   return this->curr_ != 0;
00628 }

template<ACE_SYNCH_DECL >
int ACE_Message_Queue_Iterator<>::done (  void   )  const
 

Returns 1 when all items have been seen, else 0.

Definition at line 613 of file Message_Queue_T.cpp.

References ACE_READ_GUARD_RETURN, and ACE_SYNCH_MUTEX_T. 

00614 {
00615   ACE_READ_GUARD_RETURN (ACE_SYNCH_MUTEX_T, m, this->queue_.lock_, -1)
00616 
00617   return this->curr_ == 0;
00618 }

template<ACE_SYNCH_DECL >
void ACE_Message_Queue_Iterator<>::dump (  void   )  const
 

Dump the state of an object.

Definition at line 631 of file Message_Queue_T.cpp. 

00632 {
00633 #if defined (ACE_HAS_DUMP)
00634 #endif /* ACE_HAS_DUMP */
00635 }

template<ACE_SYNCH_DECL >
int ACE_Message_Queue_Iterator<>::next (  ACE_Message_Block *&  entry  ) 
 

Pass back the that hasn't been seen in the queue. Returns 0 when all items have been seen, else 1.

Definition at line 599 of file Message_Queue_T.cpp.

References ACE_READ_GUARD_RETURN, and ACE_SYNCH_MUTEX_T.

Referenced by ACE_Buffered_Svc_Handler<, >::flush_i(). 

00600 {
00601   ACE_READ_GUARD_RETURN (ACE_SYNCH_MUTEX_T, m, this->queue_.lock_, -1)
00602 
00603   if (this->curr_ != 0)
00604     {
00605       entry = this->curr_;
00606       return 1;
00607     }
00608 
00609   return 0;
00610 }

Member Data Documentation

template<ACE_SYNCH_DECL >
ACE_Message_Queue_Iterator<>::ACE_ALLOC_HOOK_DECLARE
 

Declare the dynamic allocation hooks.

Definition at line 634 of file Message_Queue_T.h.

template<ACE_SYNCH_DECL >
ACE_Message_Block* ACE_Message_Queue_Iterator<>::curr_ [private]
 

Keeps track of how far we've advanced...

Definition at line 641 of file Message_Queue_T.h.

template<ACE_SYNCH_DECL >
ACE_Message_Queue<ACE_SYNCH_USE>& ACE_Message_Queue_Iterator<>::queue_ [private]
 

Message_Queue we are iterating over.

Definition at line 638 of file Message_Queue_T.h.

The documentation for this class was generated from the following files:
Generated on Sun Jan 27 12:55:53 2008 for ACE by doxygen 1.3.6