hnode_t Struct Reference

Hash chain node structure. More...

#include <hash.h>

Public Attributes
struct hnode_t *	next
	<Note 1 More...
struct hnode_t **	pself
	Note 3.
void *	key
	Note 4.
void *	data
	Note 5.
hash_val_t	hkey
	Note 6.

Detailed Description

Hash chain node structure.

Notes:

1. This preprocessing directive is for debugging purposes. The effect is that if the preprocessor symbol KAZLIB_OPAQUE_DEBUG is defined prior to the inclusion of this header, then the structure shall be declared as having the single member int OPAQUE. This way, any attempts by the client code to violate the principles of information hiding (by accessing the structure directly) can be diagnosed at translation time. However, note the resulting compiled unit is not suitable for linking.
2. This is a pointer to the next node in the chain. In the last node of a chain, this pointer is null.
3. This is a back-pointer to the primary pointer to this node. The primary pointer is the previous node's next pointer to this node. If there is no previous node, the primary pointer is the pointer that resides in the hash table. This back-pointer lets us handle deletions easily without searching the chain.
4. The key is a pointer to some user supplied data that contains a unique identifier for each hash node in a given table. The interpretation of the data is up to the user. When creating or initializing a hash table, the user must supply a pointer to a function for comparing two keys, and a pointer to a function for hashing a key into a numeric value.
5. The value is a user-supplied pointer to void which may refer to any data object. It is not interpreted in any way by the hashing module.
6. The hashed key is stored in each node so that we don't have to rehash each key when the table must grow or shrink.

Definition at line 149 of file hash.h.

Member Data Documentation

struct hnode_t* hnode_t::next

<Note 1

Note 2

Definition at line 152 of file hash.h.

Referenced by grow_table(), hash_lookup(), hash_node_fast_unlink(), hash_node_insert(), hash_node_unlink(), hash_scan_next(), hash_table_verify(), hnode_create(), hnode_init(), and shrink_table().

---

The documentation for this struct was generated from the following file:

• include/rnr/hash.h