diff options
Diffstat (limited to 'doc/ck_ht_entry_key_set')
| -rw-r--r-- | doc/ck_ht_entry_key_set | 93 |
1 files changed, 0 insertions, 93 deletions
diff --git a/doc/ck_ht_entry_key_set b/doc/ck_ht_entry_key_set deleted file mode 100644 index 03e53bb32e9e..000000000000 --- a/doc/ck_ht_entry_key_set +++ /dev/null @@ -1,93 +0,0 @@ -.\" -.\" Copyright 2012-2013 Samy Al Bahra. -.\" All rights reserved. -.\" -.\" Redistribution and use in source and binary forms, with or without -.\" modification, are permitted provided that the following conditions -.\" are met: -.\" 1. Redistributions of source code must retain the above copyright -.\" notice, this list of conditions and the following disclaimer. -.\" 2. Redistributions in binary form must reproduce the above copyright -.\" notice, this list of conditions and the following disclaimer in the -.\" documentation and/or other materials provided with the distribution. -.\" -.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND -.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE -.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -.\" SUCH DAMAGE. -.\" -.\" -.Dd March 30, 2012 -.Dt CK_HT_ENTRY_KEY_SET 3 -.Sh NAME -.Nm ck_ht_entry_key_set -.Nd initialize pointer to key in hash table entry -.Sh LIBRARY -Concurrency Kit (libck, \-lck) -.Sh 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" -.Sh 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 length of the key is specified by -.Fa key_length. -The maximum value of -.Fa key_length -is defined by the CK_HT_KEY_LENGTH macro. -This function is typically used to initialize an -entry for -.Xr ck_ht_get_spmc 3 -and -.Xr ck_ht_remove_spmc 3 -operations. It is expected that the entry will -be associated with a hash table initialized with -.Dv CK_HT_MODE_BYTESTRING -(see -.Xr ck_ht_init 3 -for more information). -.Sh RETURN VALUES -.Fn ck_ht_entry_key_set -has no return value. -.Sh ERRORS -This function will never fail. -.Sh SEE ALSO -.Xr ck_ht_stat 3 , -.Xr ck_ht_init 3 , -.Xr ck_ht_destroy 3 , -.Xr ck_ht_hash 3 , -.Xr ck_ht_hash_direct 3 , -.Xr ck_ht_set_spmc 3 , -.Xr ck_ht_put_spmc 3 , -.Xr ck_ht_gc 3 , -.Xr ck_ht_get_spmc 3 , -.Xr ck_ht_grow_spmc 3 , -.Xr ck_ht_remove_spmc 3 , -.Xr ck_ht_count 3 , -.Xr ck_ht_reset_spmc 3 , -.Xr ck_ht_reset_size_spmc 3 , -.Xr ck_ht_entry_empty 3 , -.Xr ck_ht_entry_key_set_direct 3 , -.Xr ck_ht_entry_key 3 , -.Xr ck_ht_entry_key_length 3 , -.Xr ck_ht_entry_value 3 , -.Xr ck_ht_entry_set 3 , -.Xr ck_ht_entry_set_direct 3 , -.Xr ck_ht_entry_key_direct 3 , -.Xr ck_ht_entry_value_direct 3 , -.Xr ck_ht_iterator_init 3 , -.Xr ck_ht_next 3 -.Pp -Additional information available at http://concurrencykit.org/ |
