Section 3: library functions
NAME ck_ht_entry_value_direct – return value as specified in hash table entry LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h Ft uintptr_t Fn ck_ht_entry_value_direct ck_ht_entry_t *entry DESCRIPTION The 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…
NAME ck_ht_entry_value – return pointer to value as specified in hash table entry LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h Ft void * Fn ck_ht_entry_value ck_ht_entry_t *entry DESCRIPTION The 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…
NAME ck_ht_entry_set_direct – initialize a key-value pair LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In 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 DESCRIPTION The 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…
NAME ck_ht_entry_set – initialize a key-value pair LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In 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 DESCRIPTION The 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…
NAME ck_ht_entry_key_set_direct – initialize key value in hash table entry LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h Ft void Fn ck_ht_entry_key_set_direct ck_ht_entry_t *entry uintptr_t key DESCRIPTION The 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…
NAME ck_ht_entry_key_set – initialize pointer to key in hash table entry LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h Ft void Fn ck_ht_entry_key_set ck_ht_entry_t *entry const void *key uint16_t key_length DESCRIPTION The 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…
NAME ck_ht_entry_key_length – returns the length of the key specified in the argument LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h Ft uint16_t Fn ck_ht_entry_key_length ck_ht_entry_t *entry DESCRIPTION The 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…
NAME ck_ht_entry_key_direct – return key value as specified in hash table entry LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h Ft uintptr_t Fn ck_ht_entry_key_direct ck_ht_entry_t *entry DESCRIPTION The 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…
NAME ck_ht_entry_key – return pointer to key as specified in hash table entry LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h Ft void * Fn ck_ht_entry_key ck_ht_entry_t *entry DESCRIPTION The 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…
NAME ck_ht_entry_empty – determine whether entry contains a key-value pair LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h Ft bool Fn ck_ht_entry_empty ck_ht_entry_t *entry DESCRIPTION The 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….
NAME ck_ht_destroy – immediately destroy a hash table LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h Ft void Fn ck_ht_destroy ck_ht_t *ht DESCRIPTION The 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…
NAME ck_ht_count – return count of key-value pairs in hash table LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_ht.h Ft uint64_t Fn ck_ht_count ck_ht_t *ht DESCRIPTION The 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…
NAME ck_hs_stat – get hash set status LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_hs.h Ft void Fn ck_hs_stat ck_hs_t *hs struct ck_hs_stat *st DESCRIPTION The Fn ck_hs_stat 3 function will store various hash set statistics in the object pointed to by Fa st . The ck_hs_stat structure is defined as follows: struct ck_hs_stat {…
NAME ck_hs_set – store key into a hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_hs.h Ft bool Fn ck_hs_set ck_hs_t *hs unsigned long hash const void *key void **previous DESCRIPTION The Fn ck_hs_set 3 function will store the key specified by the Fa key argument in the hash set pointed to by the…
NAME ck_hs_reset_size – remove all keys from a hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_hs.h Ft bool Fn ck_hs_reset_size ck_hs_t *hs unsigned long size DESCRIPTION The Fn ck_hs_reset_size 3 function will remove all keys stored in the hash set pointed to by the Fa hs argument and create a new generation of…
NAME ck_hs_reset – remove all keys from a hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_hs.h Ft bool Fn ck_hs_reset ck_hs_t *hs DESCRIPTION The Fn ck_hs_reset 3 function will remove all keys stored in the hash set pointed to by the Fa hs argument. RETURN VALUES If successful, Fn ck_hs_reset 3 will return…
NAME ck_hs_remove – remove key from a hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_hs.h Ft void * Fn ck_hs_remove ck_hs_t *hs unsigned long hash const void *key DESCRIPTION The Fn ck_hs_remove 3 function will attempt to remove the key specified by the Fa key argument in the hash set pointed to by…
NAME ck_hs_rebuild – rebuild a hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_hs.h Ft bool Fn ck_hs_rebuild ck_hs_t *hs DESCRIPTION The Fn ck_hs_rebuild 3 function will regenerate the hash set pointed to by Fa hs . This has the side-effect of pruning degradatory side-effects of workloads that are delete heavy. The regenerated hash…
NAME ck_hs_put_unique – unconditionally store unique key into a hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_hs.h Ft bool Fn ck_hs_put_unique ck_hs_t *hs unsigned long hash const void *key DESCRIPTION The Fn ck_hs_put_unique 3 function will store the key specified by the Fa key argument in the hash set pointed to by the…
NAME ck_hs_put – store unique key into a hash set LIBRARY Concurrency Kit (libck, -lck) SYNOPSIS In ck_hs.h Ft bool Fn ck_hs_put ck_hs_t *hs unsigned long hash const void *key DESCRIPTION The Fn ck_hs_put 3 function will store the key specified by the Fa key argument in the hash set pointed to by the Fa…