ACE_Hash_Map_Bucket_Iterator(3)

NAME

ACE_Hash_Map_Bucket_Iterator - Forward iterator for the ACE_Hash_Map_Manager_Ex which only traverses a particular bucket. The particular bucket is specified by the EXT_ID parameter specified in the constructor.

SYNOPSIS

#include <ace/Hash_Map_Manager_T.h>
template<class EXT_ID, class INT_ID, class HASH_KEY, class COMPARE_KEYS, class ACE_LOCK>
class ACE_Hash_Map_Bucket_Iterator
{
  public:
    ACE_Hash_Map_Bucket_Iterator (
        ACE_Hash_Map_Manager_Ex<EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK> &mm,
        const EXT_ID &ext_id,
        int tail = 0
        );
    ACE_Hash_Map_Bucket_Iterator<EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK> &operator++ (
        void
        );
    ACE_Hash_Map_Bucket_Iterator<EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK> operator++ (
        int
        );
    ACE_Hash_Map_Bucket_Iterator<EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK> &operator-- (
        void
        );
    ACE_Hash_Map_Bucket_Iterator<EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK> operator-- (
        int
        );
    ACE_Hash_Map_Entry<EXT_ID, INT_ID>& operator* (void) const;
    ACE_Hash_Map_Manager_Ex<EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK>& map (
        void
        );
    int operator== (
        const ACE_Hash_Map_Bucket_Iterator<EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK> &
        ) const;
    int operator!= (
        const ACE_Hash_Map_Bucket_Iterator<EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK> &
        ) const;
  protected:
    int forward_i (void);
    int reverse_i (void);
        ACE_Hash_Map_Manager_Ex<EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK> *map_man_;
        
    ssize_t index_;
    ACE_Hash_Map_Entry<EXT_ID, INT_ID> *next_;
};

DESCRIPTION

This class does not perform any internal locking of the ACE_Hash_Map_Manager_Ex it is iterating upon since locking is inherently inefficient and/or error-prone within an STL-style iterator. If you require locking, you can explicitly use an ACE_Guard or ACE_Read_Guard on the ACE_Hash_Map_Manager_Ex's internal lock, which is accessible via its mutex method.

Note that this iterator cannot be created by calling a method on the map, since this would require

Initialization method.

ACE_Hash_Map_Bucket_Iterator (
    ACE_Hash_Map_Manager_Ex<EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK> &mm,
    const EXT_ID &ext_id,
    int tail = 0
    );

STL styled iteration, compare, and reference functions.

ACE_Hash_Map_Bucket_Iterator<EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK> &operator++ (
    void
    );

Prefix advance.

ACE_Hash_Map_Bucket_Iterator<EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK> operator++ (
    int
    );

Postfix advance.

ACE_Hash_Map_Bucket_Iterator<EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK> &operator-- (
    void
    );

Prefix reverse.

ACE_Hash_Map_Bucket_Iterator<EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK> operator-- (
    int
    );

Postfix reverse.

ACE_Hash_Map_Entry<EXT_ID, INT_ID>& operator* (void) const;

Returns a reference to the interal element this is pointing to.

ACE_Hash_Map_Manager_Ex<EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK>& map (
    void
    );

Returns reference the Hash_Map_Manager_Ex that is being iterated over.

int operator== (
    const ACE_Hash_Map_Bucket_Iterator<EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK> &
    ) const;

int operator!= (
    const ACE_Hash_Map_Bucket_Iterator<EXT_ID, INT_ID, HASH_KEY, COMPARE_KEYS, ACE_LOCK> &
    ) const;

Check if two iterators point to the same position

AUTHOR

Doug Schmidt

LIBRARY

ace