ACE_Message_Queue_Iterator< ACE_SYNCH_DECL, TIME_POLICY > Class Template Reference

Iterator for the ACE_Message_Queue. More...

#include <Message_Queue_T.h>

Collaboration diagram for ACE_Message_Queue_Iterator< ACE_SYNCH_DECL, TIME_POLICY >:

Public Member Functions
	ACE_Message_Queue_Iterator (ACE_Message_Queue< ACE_SYNCH_USE, TIME_POLICY > &queue)
int	next (ACE_Message_Block *&entry)
int	done (void) const
	Returns 1 when all items have been seen, else 0. More...
int	advance (void)
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, TIME_POLICY > &	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 TIME_POLICY>
class ACE_Message_Queue_Iterator< ACE_SYNCH_DECL, TIME_POLICY >

Iterator for the ACE_Message_Queue.

Constructor & Destructor Documentation

template<ACE_SYNCH_DECL , class TIME_POLICY>

ACE_Message_Queue_Iterator< ACE_SYNCH_DECL, TIME_POLICY >::ACE_Message_Queue_Iterator

(

ACE_Message_Queue< ACE_SYNCH_USE, TIME_POLICY > &

queue

)

Member Function Documentation

template<ACE_SYNCH_DECL , class TIME_POLICY>

int ACE_Message_Queue_Iterator< ACE_SYNCH_DECL, TIME_POLICY >::advance

(

void

)

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

template<ACE_SYNCH_DECL , class TIME_POLICY>

int ACE_Message_Queue_Iterator< ACE_SYNCH_DECL, TIME_POLICY >::done

(

void

)

const

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

template<ACE_SYNCH_DECL , class TIME_POLICY>

void ACE_Message_Queue_Iterator< ACE_SYNCH_DECL, TIME_POLICY >::dump

(

void

)

const

Dump the state of an object.

template<ACE_SYNCH_DECL , class TIME_POLICY>

int ACE_Message_Queue_Iterator< ACE_SYNCH_DECL, TIME_POLICY >::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.

Member Data Documentation

template<ACE_SYNCH_DECL , class TIME_POLICY>

ACE_Message_Queue_Iterator< ACE_SYNCH_DECL, TIME_POLICY >::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

template<ACE_SYNCH_DECL , class TIME_POLICY>

ACE_Message_Block* ACE_Message_Queue_Iterator< ACE_SYNCH_DECL, TIME_POLICY >::curr_

private

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

template<ACE_SYNCH_DECL , class TIME_POLICY>

ACE_Message_Queue<ACE_SYNCH_USE, TIME_POLICY>& ACE_Message_Queue_Iterator< ACE_SYNCH_DECL, TIME_POLICY >::queue_

private

Message_Queue we are iterating over.

---

The documentation for this class was generated from the following files:

• Message_Queue.h
• Message_Queue_T.h