--- name: "ACE_Hash_Map_Manager_Ex" section: "3" platform: "linux" package: "libace-doc" version: "5.0.7-4" release: "Debian 2.2 (Potato)" platforms: ["linux"] url: "https://new.carta.tech/ACE_Hash_Map_Manager_Ex" --- # ACE\_Hash\_Map\_Manager\_Ex(3) Define a map abstraction that efficiently associates EXT\_IDs with INT\_IDs. ## NAME ACE\_Hash\_Map\_Manager\_Ex - Define a map abstraction that efficiently associates EXT\_IDs with INT\_IDs. ## SYNOPSIS ``` #include template class ACE_Hash_Map_Manager_Ex { public: friend class ACE_Hash_Map_Iterator_Base_Ex; friend class ACE_Hash_Map_Iterator_Ex; friend class ACE_Hash_Map_Reverse_Iterator_Ex; friend class ACE_Hash_Map_Bucket_Iterator; typedef EXT_ID KEY; typedef INT_ID VALUE; typedef ACE_Hash_Map_Entry ENTRY; typedef ACE_Hash_Map_Iterator_Ex ITERATOR; typedef ACE_Hash_Map_Reverse_Iterator_Ex REVERSE_ITERATOR; typedef ACE_Hash_Map_Iterator_Ex iterator; typedef ACE_Hash_Map_Reverse_Iterator_Ex reverse_iterator; ACE_Hash_Map_Manager_Ex (ACE_Allocator *alloc = 0); ACE_Hash_Map_Manager_Ex (size_t size, ACE_Allocator *alloc = 0); int open ( size_t size = ACE_DEFAULT_MAP_SIZE, ACE_Allocator *alloc = 0 ); int close (void); ~ACE_Hash_Map_Manager_Ex (void); int bind (const EXT_ID &item, const INT_ID &int_id); int bind ( const EXT_ID &ext_id, const INT_ID &int_id, ACE_Hash_Map_Entry *&entry ); int trybind (const EXT_ID &ext_id, INT_ID &int_id); int trybind ( const EXT_ID &ext_id, INT_ID &int_id, ACE_Hash_Map_Entry *&entry ); int rebind (const EXT_ID &ext_id, const INT_ID &int_id); int rebind ( const EXT_ID &ext_id, const INT_ID &int_id, ACE_Hash_Map_Entry *&entry ); int rebind ( const EXT_ID &ext_id, const INT_ID &int_id, INT_ID &old_int_id ); int rebind ( const EXT_ID &ext_id, const INT_ID &int_id, INT_ID &old_int_id, ACE_Hash_Map_Entry *&entry ); int rebind ( const EXT_ID &ext_id, const INT_ID &int_id, EXT_ID &old_ext_id, INT_ID &old_int_id ); int rebind ( const EXT_ID &ext_id, const INT_ID &int_id, EXT_ID &old_ext_id, INT_ID &old_int_id, ACE_Hash_Map_Entry *&entry ); int find (const EXT_ID &ext_id, INT_ID &int_id) const; int find (const EXT_ID &ext_id) const; int find ( const EXT_ID &ext_id, ACE_Hash_Map_Entry *&entry ) const; int unbind (const EXT_ID &ext_id); int unbind (const EXT_ID &ext_id, INT_ID &int_id); int unbind (ACE_Hash_Map_Entry *entry); size_t current_size (void) const; size_t total_size (void) const; ACE_LOCK &mutex (void); void dump (void) const; ACE_Hash_Map_Iterator_Ex begin ( void ); ACE_Hash_Map_Iterator_Ex end ( void ); ACE_Hash_Map_Reverse_Iterator_Ex rbegin ( void ); ACE_Hash_Map_Reverse_Iterator_Ex rend ( void ); protected: int equal (const EXT_ID &id1, const EXT_ID &id2); u_long hash (const EXT_ID &ext_id); int bind_i (const EXT_ID &ext_id, const INT_ID &int_id); int bind_i ( const EXT_ID &ext_id, const INT_ID &int_id, ACE_Hash_Map_Entry *&entry ); int trybind_i (const EXT_ID &ext_id, INT_ID &int_id); int trybind_i ( const EXT_ID &ext_id, INT_ID &int_id, ACE_Hash_Map_Entry *&entry ); int rebind_i (const EXT_ID &ext_id, const INT_ID &int_id); int rebind_i ( const EXT_ID &ext_id, const INT_ID &int_id, ACE_Hash_Map_Entry *&entry ); int rebind_i ( const EXT_ID &ext_id, const INT_ID &int_id, INT_ID &old_int_id ); int rebind_i ( const EXT_ID &ext_id, const INT_ID &int_id, INT_ID &old_int_id, ACE_Hash_Map_Entry *&entry ); int rebind_i ( const EXT_ID &ext_id, const INT_ID &int_id, EXT_ID &old_ext_id, INT_ID &old_int_id ); int rebind_i ( const EXT_ID &ext_id, const INT_ID &int_id, EXT_ID &old_ext_id, INT_ID &old_int_id, ACE_Hash_Map_Entry *&entry ); int find_i (const EXT_ID &ext_id, INT_ID &int_id); int find_i (const EXT_ID &ext_id); int find_i ( const EXT_ID &ext_id, ACE_Hash_Map_Entry *&entry ); int unbind_i (const EXT_ID &ext_id, INT_ID &int_id); int unbind_i (const EXT_ID &ext_id); int unbind_i (ACE_Hash_Map_Entry *entry); int create_buckets (size_t size); int close_i (void); ACE_Allocator *allocator_; ACE_LOCK lock_; HASH_KEY hash_key_; COMPARE_KEYS compare_keys_; private: int shared_find ( const EXT_ID &ext_id, ACE_Hash_Map_Entry *&entry, u_long &loc ); ACE_Hash_Map_Entry *table_; size_t total_size_; size_t cur_size_; }; ``` ## DESCRIPTION This implementation of a map uses a hash table. Key hashing is achieved through the HASH\_KEY object and key comparison is achieved through the COMPARE\_KEYS object. This class uses an ACE\_Allocator to allocate memory. The user can make this a persistent class by providing an ACE\_Allocator with a persistable memory pool. ## ACE-style iterator typedefs. ``` typedef ACE_Hash_Map_Iterator_Ex ITERATOR; ``` ``` typedef ACE_Hash_Map_Reverse_Iterator_Ex REVERSE_ITERATOR; ``` ## STL-style iterator typedefs. ``` typedef ACE_Hash_Map_Iterator_Ex iterator; ``` ``` typedef ACE_Hash_Map_Reverse_Iterator_Ex reverse_iterator; ``` ## Initialization and termination methods. ``` ACE_Hash_Map_Manager_Ex (ACE_Allocator *alloc = 0); ``` Initialize a Hash\_Map\_Manager\_Ex with default size. ``` ACE_Hash_Map_Manager_Ex (size_t size, ACE_Allocator *alloc = 0); ``` Initialize a Hash\_Map\_Manager\_Ex with size length. ``` int open ( size_t size = ACE_DEFAULT_MAP_SIZE, ACE_Allocator *alloc = 0 ); ``` Initialize a Hash\_Map\_Manager\_Ex with size elements. ``` int close (void); ``` Close down a Hash\_Map\_Manager\_Ex and release dynamically allocated resources. ``` ~ACE_Hash_Map_Manager_Ex (void); ``` Initialize a Hash\_Map\_Manager\_Ex with size length. ``` int bind (const EXT_ID &item, const INT_ID &int_id); ``` Associate ext\_id with int\_id. If ext\_id is already in the map then the ACE\_Hash\_Map\_Entry is not changed. Returns 0 if a new entry is bound successfully, returns 1 if an attempt is made to bind an existing entry, and returns -1 if failures occur. ``` int bind ( const EXT_ID &ext_id, const INT_ID &int_id, ACE_Hash_Map_Entry *&entry ); ``` Same as a normal bind, except the map entry is also passed back to the caller. The entry in this case will either be the newly created entry, or the existing one. ``` int trybind (const EXT_ID &ext_id, INT_ID &int_id); ``` Associate ext\_id with int\_id if and only if ext\_id is not in the map. If ext\_id is already in the map then the int\_id parameter is assigned the existing value in the map. Returns 0 if a new entry is bound successfully, returns 1 if an attempt is made to bind an existing entry, and returns -1 if failures occur. ``` int trybind ( const EXT_ID &ext_id, INT_ID &int_id, ACE_Hash_Map_Entry *&entry ); ``` Same as a normal trybind, except the map entry is also passed back to the caller. The entry in this case will either be the newly created entry, or the existing one. ``` int rebind (const EXT_ID &ext_id, const INT_ID &int_id); ``` Reassociate ext\_id with int\_id. If ext\_id is not in the map then behaves just like bind. Returns 0 if a new entry is bound successfully, returns 1 if an existing entry was rebound, and returns -1 if failures occur. ``` int rebind ( const EXT_ID &ext_id, const INT_ID &int_id, ACE_Hash_Map_Entry *&entry ); ``` Same as a normal rebind, except the map entry is also passed back to the caller. The entry in this case will either be the newly created entry, or the existing one. ``` int rebind ( const EXT_ID &ext_id, const INT_ID &int_id, INT_ID &old_int_id ); ``` Associate ext\_id with int\_id. If ext\_id is not in the map then behaves just like bind. Otherwise, store the old value of int\_id into the "out" parameter and rebind the new parameters. Returns 0 if a new entry is bound successfully, returns 1 if an existing entry was rebound, and returns -1 if failures occur. ``` int rebind ( const EXT_ID &ext_id, const INT_ID &int_id, INT_ID &old_int_id, ACE_Hash_Map_Entry *&entry ); ``` Same as a normal rebind, except the map entry is also passed back to the caller. The entry in this case will either be the newly created entry, or the existing one. ``` int rebind ( const EXT_ID &ext_id, const INT_ID &int_id, EXT_ID &old_ext_id, INT_ID &old_int_id ); ``` Associate ext\_id with int\_id. If ext\_id is not in the map then behaves just like bind. Otherwise, store the old values of ext\_id and int\_id into the "out" parameters and rebind the new parameters. This is very useful if you need to have an atomic way of updating ACE\_Hash\_Map\_Entrys and you also need full control over memory allocation. Returns 0 if a new entry is bound successfully, returns 1 if an existing entry was rebound, and returns -1 if failures occur. ``` int rebind ( const EXT_ID &ext_id, const INT_ID &int_id, EXT_ID &old_ext_id, INT_ID &old_int_id, ACE_Hash_Map_Entry *&entry ); ``` Same as a normal rebind, except the map entry is also passed back to the caller. The entry in this case will either be the newly created entry, or the existing one. ``` int find (const EXT_ID &ext_id, INT_ID &int_id) const; ``` Locate ext\_id and pass out parameter via int\_id. If found, return 0, returns -1 if not found. ``` int find (const EXT_ID &ext_id) const; ``` Returns 0 if the ext\_id is in the mapping, otherwise -1. ``` int find ( const EXT_ID &ext_id, ACE_Hash_Map_Entry *&entry ) const; ``` Locate ext\_id and pass out parameter via entry. If found, return 0, returns -1 if not found. ``` int unbind (const EXT_ID &ext_id); ``` Unbind (remove) the ext\_id from the map. Don't return the int\_id to the caller (this is useful for collections where the int\_ids are \*not\* dynamically allocated...) ``` int unbind (const EXT_ID &ext_id, INT_ID &int_id); ``` Break any association of ext\_id. Returns the value of int\_id in case the caller needs to deallocate memory. ``` int unbind (ACE_Hash_Map_Entry *entry); ``` Remove entry from map. ``` size_t current_size (void) const; ``` Return the current size of the map. ``` size_t total_size (void) const; ``` Return the total size of the map. ``` ACE_LOCK &mutex (void); ``` Returns a reference to the underlying ACE\_LOCK. This makes it possible to acquire the lock explicitly, which can be useful in some cases if you instantiate the ACE\_Atomic\_Op with an ACE\_Recursive\_Mutex or ACE\_Process\_Mutex, or if you need to guard the state of an iterator. NOTE: the right name would be lock, but HP/C++ will choke on that! ``` void dump (void) const; ``` Dump the state of an object. ## STL styled iterator factory functions. ``` ACE_Hash_Map_Iterator_Ex begin ( void ); ``` ``` ACE_Hash_Map_Iterator_Ex end ( void ); ``` Return forward iterator. ``` ACE_Hash_Map_Reverse_Iterator_Ex rbegin ( void ); ``` ``` ACE_Hash_Map_Reverse_Iterator_Ex rend ( void ); ``` Return reverse iterator. ## The following methods do the actual work. ``` int equal (const EXT_ID &id1, const EXT_ID &id2); ``` Returns 1 if id1 == id2, else 0. This is defined as a separate method to facilitate template specialization. ``` u_long hash (const EXT_ID &ext_id); ``` Compute the hash value of the ext\_id. This is defined as a separate method to facilitate template specialization. ## These methods assume locks are held by private methods. ``` int bind_i (const EXT_ID &ext_id, const INT_ID &int_id); ``` Performs bind. Must be called with locks held. ``` int bind_i ( const EXT_ID &ext_id, const INT_ID &int_id, ACE_Hash_Map_Entry *&entry ); ``` Performs bind. Must be called with locks held. ``` int trybind_i (const EXT_ID &ext_id, INT_ID &int_id); ``` Performs trybind. Must be called with locks held. ``` int trybind_i ( const EXT_ID &ext_id, INT_ID &int_id, ACE_Hash_Map_Entry *&entry ); ``` Performs trybind. Must be called with locks held. ``` int rebind_i (const EXT_ID &ext_id, const INT_ID &int_id); ``` Performs rebind. Must be called with locks held. ``` int rebind_i ( const EXT_ID &ext_id, const INT_ID &int_id, ACE_Hash_Map_Entry *&entry ); ``` Performs rebind. Must be called with locks held. ``` int rebind_i ( const EXT_ID &ext_id, const INT_ID &int_id, INT_ID &old_int_id ); ``` Performs rebind. Must be called with locks held. ``` int rebind_i ( const EXT_ID &ext_id, const INT_ID &int_id, INT_ID &old_int_id, ACE_Hash_Map_Entry *&entry ); ``` Performs rebind. Must be called with locks held. ``` int rebind_i ( const EXT_ID &ext_id, const INT_ID &int_id, EXT_ID &old_ext_id, INT_ID &old_int_id ); ``` Performs rebind. Must be called with locks held. ``` int rebind_i ( const EXT_ID &ext_id, const INT_ID &int_id, EXT_ID &old_ext_id, INT_ID &old_int_id, ACE_Hash_Map_Entry *&entry ); ``` Performs rebind. Must be called with locks held. ``` int find_i (const EXT_ID &ext_id, INT_ID &int_id); ``` Performs a find of int\_id using ext\_id as the key. Must be called with locks held. ``` int find_i (const EXT_ID &ext_id); ``` Performs a find using ext\_id as the key. Must be called with locks held. ``` int find_i ( const EXT_ID &ext_id, ACE_Hash_Map_Entry *&entry ); ``` Performs a find using ext\_id as the key. Must be called with locks held. ``` int unbind_i (const EXT_ID &ext_id, INT_ID &int_id); ``` Performs unbind. Must be called with locks held. ``` int unbind_i (const EXT_ID &ext_id); ``` Performs unbind. Must be called with locks held. ``` int unbind_i (ACE_Hash_Map_Entry *entry); ``` Performs unbind. Must be called with locks held. ``` int create_buckets (size_t size); ``` Resize the map. Must be called with locks held. Note, that this method should never be called more than once or else all the hashing will get screwed up as the size will change. ``` int close_i (void); ``` Close down a Map\_Manager\_Ex. Must be called with locks held. ``` ACE_Allocator *allocator_; ``` Pointer to a memory allocator. ``` ACE_LOCK lock_; ``` Synchronization variable for the MT\_SAFE ACE\_Hash\_Map\_Manager\_Ex. ``` HASH_KEY hash_key_; ``` Function object used for hashing keys. ``` COMPARE_KEYS compare_keys_; ``` Function object used for comparing keys. ## AUTHOR Doug Schmidt ## LIBRARY ace