Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

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 Methods

 ACE_Message_Queue_Iterator (ACE_Message_Queue< ACE_SYNCH_USE > &queue)
int next (ACE_Message_Block *&entry)
 Pass back the <entry> that hasn't been seen in the queue. Returns 0 when all items have been seen, else 1. More...

int done (void) const
 Returns 1 when all items have been seen, else 0. More...

int advance (void)
 Move forward by one element in the queue. Returns 0 when all the items in the set have been seen, else 1. More...

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


Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks. More...


Private Attributes

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

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

Detailed Description

template<ACE_SYNCH_DECL>
class ACE_Message_Queue_Iterator<>

Iterator for the <ACE_Message_Queue>.

Definition at line 530 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 338 of file Message_Queue_T.cpp. 

00339   : queue_ (q),
00340     curr_ (q.head_)
00341 {
00342 }

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 367 of file Message_Queue_T.cpp.

References ACE_READ_GUARD_RETURN, ACE_SYNCH_MUTEX_T, curr_, and ACE_Message_Block::next. 

00368 {
00369   ACE_READ_GUARD_RETURN (ACE_SYNCH_MUTEX_T, m, this->queue_.lock_, -1)
00370 
00371   if (this->curr_)
00372     this->curr_ = this->curr_->next ();
00373   return this->curr_ != 0;
00374 }

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 359 of file Message_Queue_T.cpp.

References ACE_READ_GUARD_RETURN, ACE_SYNCH_MUTEX_T, and curr_. 

00360 {
00361   ACE_READ_GUARD_RETURN (ACE_SYNCH_MUTEX_T, m, this->queue_.lock_, -1)
00362 
00363   return this->curr_ == 0;
00364 }

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

Dump the state of an object.

Definition at line 377 of file Message_Queue_T.cpp. 

00378 {
00379 }

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

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

Definition at line 345 of file Message_Queue_T.cpp.

References ACE_READ_GUARD_RETURN, ACE_SYNCH_MUTEX_T, and curr_.

Referenced by ACE_Buffered_Svc_Handler::flush_i. 

00346 {
00347   ACE_READ_GUARD_RETURN (ACE_SYNCH_MUTEX_T, m, this->queue_.lock_, -1)
00348 
00349   if (this->curr_ != 0)
00350     {
00351       entry = this->curr_;
00352       return 1;
00353     }
00354 
00355   return 0;
00356 }

Member Data Documentation

template<ACE_SYNCH_DECL >
ACE_Message_Queue_Iterator::ACE_ALLOC_HOOK_DECLARE
 

Declare the dynamic allocation hooks.

Definition at line 552 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 559 of file Message_Queue_T.h.

Referenced by advance, done, and next.

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 556 of file Message_Queue_T.h.

The documentation for this class was generated from the following files:
Generated on Mon Jun 16 12:50:37 2003 for ACE by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002