sipxportlib  Version 3.3
Public Member Functions | Protected Member Functions | Friends | List of all members
UtlHashBagIterator Class Reference

#include <UtlHashBagIterator.h>

Inheritance diagram for UtlHashBagIterator:
Inheritance graph
Collaboration diagram for UtlHashBagIterator:
Collaboration graph

Public Member Functions

 UtlHashBagIterator (const UtlHashBag &hashBag, UtlContainable *key=NULL)
virtual ~UtlHashBagIterator ()
virtual UtlContainableoperator() ()
virtual void reset ()
UtlContainablekey () const
- Public Member Functions inherited from UtlIterator
 UtlIterator (const UtlContainer &container)
virtual ~UtlIterator ()=0

Protected Member Functions

virtual void removing (const UtlLink *node)
- Protected Member Functions inherited from UtlIterator
void addToContainer (const UtlContainer *container)
virtual void invalidate ()


class UtlHashBag

Additional Inherited Members

- Protected Attributes inherited from UtlIterator
OsBSem mContainerRefLock

Detailed Description

UtlHashBagIterator allows developers to iterator (walks through) an UtlHashBag.

See also

Constructor & Destructor Documentation

UtlHashBagIterator ( const UtlHashBag hashBag,
UtlContainable key = NULL 

Construct an iterator over all objects in a given UtlHashBag If key is specified, iterate only over objects that match that key (UtlHashBags may have any number of copies of a given object)

~UtlHashBagIterator ( )


Member Function Documentation

UtlContainable * operator() ( )

Return the next element.

The next element or NULL if no more elements are available.

Implements UtlIterator.

void reset ( void  )

Reset the list by moving the iterator cursor to the location before the first element.

Implements UtlIterator.

UtlContainable * key ( ) const

Gets the key of the current element

void removing ( const UtlLink node)

removing is called by the UtlHashMap when an element is about to be removed from the container. The iterator must ensure that the element for the removed node is not returned by any subsequent call.

Friends And Related Function Documentation

friend class UtlHashBag