Section 3: library functions
ck_ht_next – iterate to next entry in hash table LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_ht.h Ft bool Fn ck_ht_next ck_ht_t *ht ck_ht_iterator_t *iterator ck_ht_entry_t **entry DescriptionThe Fn ck_ht_next function will increment the iterator object pointed to by Fa iterator to point to the next non-empty hash table entry. If Fn ck_ht_next returns true then the…
ck_ht_iterator_init – initialize hash table iterator LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_ht.h ck_ht_iterator_t iterator = CK_HT_ITERATOR_INITIALIZER Ft void Fn ck_ht_iterator_init ck_ht_iterator_t *iterator DescriptionThe Fn ck_ht_iterator_init function will initialize the object pointed to by the Fa iterator argument. Alternatively, an iterator may be statically initialized by assigning it the CK_HT_ITERATOR_INITIALIZER value. An iterator is used to…
ck_ht_init – initialize a hash table LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_ht.h Ft typedef void Fn ck_ht_hash_cb_t ck_ht_hash_t *h const void *key size_t key_length uint64_t seed Ft bool Fn ck_ht_init ck_ht_t *ht enum ck_ht_mode mode ck_ht_hash_cb_t *hash_function struct ck_malloc *allocator uint64_t capacity uint64_t seed DescriptionThe Fn ck_ht_init function initializes the hash table pointed to by…
ck_ht_hash_direct – generate a hash value for a hash table LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_ht.h Ft void Fn ck_ht_hash_direct ck_ht_hash_t *h ck_ht_t *ht uintptr_t key DescriptionThe Fn ck_ht_hash_direct function will generate a hash value in the object pointed to by the Fa h argument. The hash value is valid for use in the hash…
ck_ht_hash – generate a hash value for a hash table LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_ht.h Ft void Fn ck_ht_hash ck_ht_hash_t *h ck_ht_t *ht const void *key uint16_t key_length DescriptionThe Fn ck_ht_hash function will generate a hash value in the object pointed to by the Fa h argument. The hash value is valid for use…
ck_ht_grow_spmc – resize a hash table if necessary LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_ht.h Ft bool Fn ck_ht_grow_spmc ck_ht_t *ht uint64_t capacity DescriptionThe Fn ck_ht_grow_spmc function will resize the hash table in order to be able to at least store the number of entries specified by Fa capacity at a load factor of one. The…
ck_ht_get_spmc – load a key-value pair from a hash table LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_ht.h Ft bool Fn ck_ht_get_spmc ck_ht_t *ht ck_ht_hash_t h ck_ht_entry_t *entry DescriptionThe Fn ck_ht_get_spmc function will return the value associated with the key specified in the Fa entry argument in the hash table pointed to by the Fa ht argument….
ck_ht_gc – perform maintenance on a hash table LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_ht.h Ft bool Fn ck_ht_gc ck_ht_t *ht unsigned long cycles unsigned long seed DescriptionThe Fn ck_ht_gc function will perform various maintenance routines on the hash table pointed to by Fa ht , including defragmentation of probe sequences with respect to tombstones and…
ck_ht_entry_value_direct – return value as specified in hash table entry LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_ht.h Ft uintptr_t Fn ck_ht_entry_value_direct ck_ht_entry_t *entry DescriptionThe Fn ck_ht_entry_value_direct function will return the value of the key-value pair as specified in the object pointed to by the Fa entry argument. It is expected that the entry is associated with…
ck_ht_entry_value – return pointer to value as specified in hash table entry LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_ht.h Ft void * Fn ck_ht_entry_value ck_ht_entry_t *entry DescriptionThe Fn ck_ht_entry_value function will return the value pointer as specified in the object pointed to by the Fa entry argument. It is expected that the entry is associated with…
ck_ht_entry_set_direct – initialize a key-value pair LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_ht.h Ft void Fn ck_ht_entry_set_direct ck_ht_entry_t *entry ck_ht_hash_t h uintptr_t key uintptr_t value DescriptionThe Fn ck_ht_entry_set function will initialize the object pointed to by Fa entry with the hash value specified by the Fa h argument, the key value specified in the Fa key…
ck_ht_entry_set – initialize a key-value pair LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_ht.h Ft void Fn ck_ht_entry_set ck_ht_entry_t *entry ck_ht_hash_t h const void *key uint16_t key_length const void *value DescriptionThe Fn ck_ht_entry_set function will initialize the object pointed to by Fa entry with a key pointed to by the Fa key argument and a value pointed…
ck_ht_entry_key_set_direct – initialize key value in hash table entry LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_ht.h Ft void Fn ck_ht_entry_key_set_direct ck_ht_entry_t *entry uintptr_t key DescriptionThe Fn ck_ht_entry_key_set_direct function will initialize the object pointed to by Fa entry with the key value specified in the Fa key argument. This function is typically used to initialize an entry…
ck_ht_entry_key_set – initialize pointer to key in hash table entry LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_ht.h Ft void Fn ck_ht_entry_key_set ck_ht_entry_t *entry const void *key uint16_t key_length DescriptionThe Fn ck_ht_entry_key_set function will initialize the object pointed to by Fa entry with a key pointed to by the Fa key argument. The length of the key…
ck_ht_entry_key_length – returns the length of the key specified in the argument LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_ht.h Ft uint16_t Fn ck_ht_entry_key_length ck_ht_entry_t *entry DescriptionThe Fn ck_ht_entry_key_length function will return the length of the key associated with the object pointed to by the Fa entry argument. It is expected that the entry is associated with…
ck_ht_entry_key_direct – return key value as specified in hash table entry LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_ht.h Ft uintptr_t Fn ck_ht_entry_key_direct ck_ht_entry_t *entry DescriptionThe Fn ck_ht_entry_key_direct function will return the key value as specified in the object pointed to by the Fa entry argument. It is expected that the entry is associated with a hash…
ck_ht_entry_key – return pointer to key as specified in hash table entry LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_ht.h Ft void * Fn ck_ht_entry_key ck_ht_entry_t *entry DescriptionThe Fn ck_ht_entry_key function will return the key pointer as specified in the object pointed to by the Fa entry argument. It is expected that the entry is associated with…
ck_ht_entry_empty – determine whether entry contains a key-value pair LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_ht.h Ft bool Fn ck_ht_entry_empty ck_ht_entry_t *entry DescriptionThe Fn ck_ht_entry_empty function will return false if Fa entry points to a valid key-value pair. If Fa entry does not point to a valid key-value pair it returns true. It is expected that…
ck_ht_destroy – immediately destroy a hash table LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_ht.h Ft void Fn ck_ht_destroy ck_ht_t *ht DescriptionThe Fn ck_ht_destroy function will request that the underlying allocator, as specified by the ck_ht_init3 function, immediately destroy the object pointed to by the Fa ht argument. The user must guarantee that no threads are accessing…
ck_ht_count – return count of key-value pairs in hash table LibraryConcurrency Kit (libck, -lck) SynopsisIn ck_ht.h Ft uint64_t Fn ck_ht_count ck_ht_t *ht DescriptionThe Fn ck_ht_count function will return the number of entries in the hash table pointed to be the Fa ht argument. The function may only be called without the presence of concurrent write…