ACE_Malloc_LIFO_Iterator_T< ACE_MEM_POOL_1, ACE_LOCK, ACE_CB > Class Template Reference

LIFO iterator for names stored in Malloc'd memory. More...

#include <Malloc_T.h>

Collaboration diagram for ACE_Malloc_LIFO_Iterator_T< ACE_MEM_POOL_1, ACE_LOCK, ACE_CB >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef ACE_CB::ACE_Name_Node NAME_NODE
typedef ACE_CB::ACE_Malloc_Header MALLOC_HEADER

Public Member Functions

 ACE_Malloc_LIFO_Iterator_T (ACE_Malloc_T< ACE_MEM_POOL_2, ACE_LOCK, ACE_CB > &malloc, const char *name=0)
 ~ACE_Malloc_LIFO_Iterator_T (void)
 Destructor.
int done (void) const
 Returns 1 when all items have been seen, else 0.
int next (void *&next_entry)
int next (void *&next_entry, const char *&name)
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_Malloc_T< ACE_MEM_POOL_2,
ACE_LOCK, ACE_CB > & 		malloc_
 Malloc we are iterating over.
NAME_NODE * curr_
 Keeps track of how far we've advanced...
ACE_Read_Guard< ACE_LOCK > guard_
 Lock Malloc for the lifetime of the iterator.
const char * name_
 Name that we are searching for.

Detailed Description

template<ACE_MEM_POOL_1, class ACE_LOCK, class ACE_CB>
class ACE_Malloc_LIFO_Iterator_T< ACE_MEM_POOL_1, ACE_LOCK, ACE_CB >

LIFO iterator for names stored in Malloc'd memory.

This class can be configured flexibly with different types of ACE_LOCK strategies that support the ACE_Thread_Mutex and ACE_Process_Mutex constructor API.

Does not support deletions while iteration is occurring.

Definition at line 721 of file Malloc_T.h.

Member Typedef Documentation

template<ACE_MEM_POOL_1 , class ACE_LOCK, class ACE_CB>
typedef ACE_CB::ACE_Malloc_Header ACE_Malloc_LIFO_Iterator_T< ACE_MEM_POOL_1, ACE_LOCK, ACE_CB >::MALLOC_HEADER

Definition at line 725 of file Malloc_T.h.

template<ACE_MEM_POOL_1 , class ACE_LOCK, class ACE_CB>
typedef ACE_CB::ACE_Name_Node ACE_Malloc_LIFO_Iterator_T< ACE_MEM_POOL_1, ACE_LOCK, ACE_CB >::NAME_NODE

Definition at line 724 of file Malloc_T.h.

Constructor & Destructor Documentation

template<ACE_MEM_POOL_1 , class ACE_LOCK, class ACE_CB>
ACE_Malloc_LIFO_Iterator_T< ACE_MEM_POOL_1, ACE_LOCK, ACE_CB >::ACE_Malloc_LIFO_Iterator_T ( ACE_Malloc_T< ACE_MEM_POOL_2, ACE_LOCK, ACE_CB > &  malloc,
const char *  name = 0 
) [inline]

If name = 0 it will iterate through everything else only through those entries whose name match.

Definition at line 1064 of file Malloc_T.cpp.

01066   : malloc_ (malloc),
01067     curr_ (0),
01068     guard_ (*malloc_.lock_),
01069     name_ (name != 0 ? ACE_OS::strdup (name) : 0)
01070 {
01071   ACE_TRACE ("ACE_Malloc_LIFO_Iterator_T<ACE_MEM_POOL_2, ACE_LOCK, ACE_CB>::ACE_Malloc_LIFO_Iterator_T");
01072   // Cheap trick to make code simple.
01073   // @@ Doug, this looks like trouble...
01074   NAME_NODE temp;
01075   this->curr_ = &temp;
01076   this->curr_->next_ = malloc_.cb_ptr_->name_head_;
01077 
01078   this->advance ();
01079 }

template<ACE_MEM_POOL_1 , class ACE_LOCK , class ACE_CB >
ACE_Malloc_LIFO_Iterator_T< ACE_MEM_POOL_1, ACE_LOCK, ACE_CB >::~ACE_Malloc_LIFO_Iterator_T ( void   )  [inline]

Destructor.

Definition at line 1082 of file Malloc_T.cpp.

01083 {
01084   ACE_OS::free ((void *) this->name_);
01085 }

Member Function Documentation

template<ACE_MEM_POOL_1 , class ACE_LOCK , class ACE_CB >
int ACE_Malloc_LIFO_Iterator_T< ACE_MEM_POOL_1, ACE_LOCK, ACE_CB >::advance ( void   )  [inline]

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

Definition at line 1126 of file Malloc_T.cpp.

01127 {
01128   ACE_TRACE ("ACE_Malloc_LIFO_Iterator_T<ACE_MEM_POOL_2, ACE_LOCK, ACE_CB>::advance");
01129 
01130   this->curr_ = this->curr_->next_;
01131 
01132   if (this->name_ == 0)
01133     return this->curr_ != 0;
01134 
01135   while (this->curr_ != 0
01136          && ACE_OS::strcmp (this->name_,
01137                             this->curr_->name ()) != 0)
01138     this->curr_ = this->curr_->next_;
01139 
01140   return this->curr_ != 0;
01141 }

template<ACE_MEM_POOL_1 , class ACE_LOCK , class ACE_CB >
int ACE_Malloc_LIFO_Iterator_T< ACE_MEM_POOL_1, ACE_LOCK, ACE_CB >::done ( void   )  const [inline]

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

Definition at line 1118 of file Malloc_T.cpp.

01119 {
01120   ACE_TRACE ("ACE_Malloc_LIFO_Iterator_T<ACE_MEM_POOL_2, ACE_LOCK, ACE_CB>::done");
01121 
01122   return this->curr_ == 0;
01123 }

template<ACE_MEM_POOL_1 , class ACE_LOCK , class ACE_CB >
void ACE_Malloc_LIFO_Iterator_T< ACE_MEM_POOL_1, ACE_LOCK, ACE_CB >::dump ( void   )  const [inline]

Dump the state of an object.

Definition at line 1050 of file Malloc_T.cpp.

01051 {
01052 #if defined (ACE_HAS_DUMP)
01053   ACE_TRACE ("ACE_Malloc_LIFO_Iterator_T<ACE_MEM_POOL_2, ACE_LOCK, ACE_CB>::dump");
01054 
01055   ACE_DEBUG ((LM_DEBUG, ACE_BEGIN_DUMP, this));
01056   this->curr_->dump ();
01057   this->guard_.dump ();
01058   ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("name_ = %C\n"), this->name_));
01059   ACE_DEBUG ((LM_DEBUG, ACE_END_DUMP));
01060 #endif /* ACE_HAS_DUMP */
01061 }

template<ACE_MEM_POOL_1 , class ACE_LOCK , class ACE_CB >
int ACE_Malloc_LIFO_Iterator_T< ACE_MEM_POOL_1, ACE_LOCK, ACE_CB >::next ( void *&  next_entry,
const char *&  name 
) [inline]

Pass back the next entry (and the name associated with it) in the set that hasn't yet been visited. Returns 0 when all items have been seen, else 1.

Definition at line 1088 of file Malloc_T.cpp.

01090 {
01091   ACE_TRACE ("ACE_Malloc_LIFO_Iterator_T<ACE_MEM_POOL_2, ACE_LOCK, ACE_CB>::next");
01092 
01093   if (this->curr_ != 0)
01094     {
01095       next_entry = (char *) this->curr_->pointer_;
01096       name = this->curr_->name ();
01097       return 1;
01098     }
01099   else
01100     return 0;
01101 }

template<ACE_MEM_POOL_1 , class ACE_LOCK , class ACE_CB >
int ACE_Malloc_LIFO_Iterator_T< ACE_MEM_POOL_1, ACE_LOCK, ACE_CB >::next ( void *&  next_entry  )  [inline]

Pass back the next entry in the set that hasn't yet been visited. Returns 0 when all items have been seen, else 1.

Definition at line 1104 of file Malloc_T.cpp.

01105 {
01106   ACE_TRACE ("ACE_Malloc_LIFO_Iterator_T<ACE_MEM_POOL_2, ACE_LOCK, ACE_CB>::next");
01107 
01108   if (this->curr_ != 0)
01109     {
01110       next_entry = this->curr_->pointer_;
01111       return 1;
01112     }
01113   else
01114     return 0;
01115 }

Member Data Documentation

template<ACE_MEM_POOL_1 , class ACE_LOCK, class ACE_CB>
ACE_Malloc_LIFO_Iterator_T< ACE_MEM_POOL_1, ACE_LOCK, ACE_CB >::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

Definition at line 761 of file Malloc_T.h.

template<ACE_MEM_POOL_1 , class ACE_LOCK, class ACE_CB>
NAME_NODE* ACE_Malloc_LIFO_Iterator_T< ACE_MEM_POOL_1, ACE_LOCK, ACE_CB >::curr_ [private]

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

Definition at line 768 of file Malloc_T.h.

template<ACE_MEM_POOL_1 , class ACE_LOCK, class ACE_CB>
ACE_Read_Guard<ACE_LOCK> ACE_Malloc_LIFO_Iterator_T< ACE_MEM_POOL_1, ACE_LOCK, ACE_CB >::guard_ [private]

Lock Malloc for the lifetime of the iterator.

Definition at line 771 of file Malloc_T.h.

template<ACE_MEM_POOL_1 , class ACE_LOCK, class ACE_CB>
ACE_Malloc_T<ACE_MEM_POOL_2, ACE_LOCK, ACE_CB>& ACE_Malloc_LIFO_Iterator_T< ACE_MEM_POOL_1, ACE_LOCK, ACE_CB >::malloc_ [private]

Malloc we are iterating over.

Definition at line 765 of file Malloc_T.h.

template<ACE_MEM_POOL_1 , class ACE_LOCK, class ACE_CB>
const char* ACE_Malloc_LIFO_Iterator_T< ACE_MEM_POOL_1, ACE_LOCK, ACE_CB >::name_ [private]

Name that we are searching for.

Definition at line 774 of file Malloc_T.h.

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Fri Nov 6 23:24:01 2009 for ACE by  doxygen 1.6.1