void *cp_rbtree_insert(cp_rbtree *tree, void *key, void *value);
void *cp_rbtree_get(cp_rbtree *tree, void *key);
void *cp_rbtree_delete(cp_rbtree *tree, void *key);
int cp_rbtree_contains(cp_rbtree *tree, void *key);
long cp_rbtree_count(cp_rbtree *tree);
cp_rbtree_get returns the current mapping for the requested key or NULL if none exists. Unless COLLECTION_MODE_NOSYNC is set, the tree is read-locked. If COLLECTION_MODE_MULTIPLE_VALUES is set, the returned value is a cp_vector(3) object containing all values for the given key.
cp_rbtree_delete removes the current mapping for the given key and returns the value associated to it or NULL if there was no mapping for the given key. The return value is usable to indicate that a deletion has taken place. Note that the returned pointer may be invalid if COLLECTION_MODE_DEEP is set and the tree has a non-null value destructor function set. Unless COLLECTION_MODE_NOSYNC is set, the deletion function write-locks the tree.
cp_rbtree_contains returns non-zero if the tree contains a mapping for the given key or zero if not.
cp_rbtree_count returns the number of mappings currently stored in a tree.
Note that these functions may fail if locking fails. This means that for a synchronized table (ie COLLECTION_MODE_NOSYNC not set), cp_rbtree_get could return NULL although a mapping actually exists. Applications should check errno to determine whether no mapping was found (errno not set) or locking has failed (errno will be set to EBUSY, EINVAL or EDEADLK).
cp_rbtree_contains returns non-zero if the tree contains a mapping for the requested key or zero if no mapping was found or on locking errors - see above.
cp_rbtree_count returns the number of mappings currently stored.
This document was created by
using the manual pages.
Time: 10:00:49 GMT, May 30, 2006