Samy Al Bahra
13 years ago
parent
319ae636d2
commit
4ea160d291
@ -0,0 +1,90 @@
|
||||
.\"
|
||||
.\" Copyright 2012 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_SET 3
|
||||
.Sh NAME
|
||||
.Nm ck_ht_entry_set
|
||||
.Nd initialize a key-value pair
|
||||
.Sh LIBRARY
|
||||
Concurrency Kit (libck, \-lck)
|
||||
.Sh 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"
|
||||
.Sh 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 and a value pointed to by the
|
||||
.Fa value
|
||||
argument. The length of the key is specified by
|
||||
.Fa key_length.
|
||||
This function is typically used to initialize an
|
||||
entry for
|
||||
.Xr ck_ht_set_spmc 3
|
||||
and
|
||||
.Xr ck_ht_put_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_set
|
||||
has no return value.
|
||||
.Sh ERRORS
|
||||
This function will never fail.
|
||||
.Sh SEE ALSO
|
||||
.Xr ck_ht_init 3 ,
|
||||
.Xr ck_ht_destroy 3 ,
|
||||
.Xr ck_ht_allocator_set 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_get_spmc 3 ,
|
||||
.Xr ck_ht_grow_spmc 3 ,
|
||||
.Xr ck_ht_remove_spmc 3 ,
|
||||
.Xr ck_ht_count 3 ,
|
||||
.Xr ck_ht_reset 3 ,
|
||||
.Xr ck_ht_entry_empty 3 ,
|
||||
.Xr ck_ht_entry_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_key_set 3 ,
|
||||
.Xr ck_ht_entry_key_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/
|
||||
@ -0,0 +1,90 @@
|
||||
.\"
|
||||
.\" Copyright 2012 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_SET_DIRECT 3
|
||||
.Sh NAME
|
||||
.Nm ck_ht_entry_set_direct
|
||||
.Nd initialize a key-value pair
|
||||
.Sh LIBRARY
|
||||
Concurrency Kit (libck, \-lck)
|
||||
.Sh SYNOPSIS
|
||||
.In ck_ht.h
|
||||
.Ft void
|
||||
.Fn ck_ht_entry_set "ck_ht_entry_t *entry" "uintptr_t key" "uintptr_t value"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Fn ck_ht_entry_set
|
||||
function will initialize the object pointed to by
|
||||
.Fa entry
|
||||
with the key value specified in the
|
||||
.Fa key
|
||||
argument and a value specified by the
|
||||
.Fa value
|
||||
argument.
|
||||
.Pp
|
||||
This function is typically used to initialize an
|
||||
entry for
|
||||
.Xr ck_ht_set_spmc 3
|
||||
and
|
||||
.Xr ck_ht_put_spmc 3
|
||||
operations. It is expected that the entry will
|
||||
be associated with a hash table initialized with
|
||||
.Dv CK_HT_MODE_DIRECT
|
||||
(see
|
||||
.Xr ck_ht_init 3
|
||||
for more information).
|
||||
.Sh RETURN VALUES
|
||||
.Fn ck_ht_entry_set_direct
|
||||
has no return value.
|
||||
.Sh ERRORS
|
||||
This function will never fail.
|
||||
.Sh SEE ALSO
|
||||
.Xr ck_ht_init 3 ,
|
||||
.Xr ck_ht_destroy 3 ,
|
||||
.Xr ck_ht_allocator_set 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_get_spmc 3 ,
|
||||
.Xr ck_ht_grow_spmc 3 ,
|
||||
.Xr ck_ht_remove_spmc 3 ,
|
||||
.Xr ck_ht_count 3 ,
|
||||
.Xr ck_ht_reset 3 ,
|
||||
.Xr ck_ht_entry_empty 3 ,
|
||||
.Xr ck_ht_entry_key 3 ,
|
||||
.Xr ck_ht_entry_key_length 3 ,
|
||||
.Xr ck_ht_entry_value 3 ,
|
||||
.Xr ck_ht_entry_key_set 3 ,
|
||||
.Xr ck_ht_entry_key_set_direct 3 ,
|
||||
.Xr ck_ht_entry_set 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/
|
||||
@ -0,0 +1,86 @@
|
||||
.\"
|
||||
.\" Copyright 2012 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_VALUE 3
|
||||
.Sh NAME
|
||||
.Nm ck_ht_entry_value
|
||||
.Nd return pointer to value as specified in hash table entry
|
||||
.Sh LIBRARY
|
||||
Concurrency Kit (libck, \-lck)
|
||||
.Sh SYNOPSIS
|
||||
.In ck_ht.h
|
||||
.Ft void *
|
||||
.Fn ck_ht_entry_value "ck_ht_entry_t *entry"
|
||||
.Sh 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.
|
||||
.Pp
|
||||
It is expected that the entry is
|
||||
associated with a hash table initialized with
|
||||
.Dv CK_HT_MODE_BYTESTRING
|
||||
(see
|
||||
.Xr ck_ht_init 3
|
||||
for more information).
|
||||
.Sh RETURN VALUES
|
||||
The
|
||||
.Fn ck_ht_entry_value
|
||||
function returns the value pointed to by
|
||||
.Dv entry.
|
||||
.Sh ERRORS
|
||||
Behavior is undefined if
|
||||
.Fa entry
|
||||
has not been initialized or if the key is empty.
|
||||
.Sh SEE ALSO
|
||||
.Xr ck_ht_init 3 ,
|
||||
.Xr ck_ht_destroy 3 ,
|
||||
.Xr ck_ht_allocator_set 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_get_spmc 3 ,
|
||||
.Xr ck_ht_grow_spmc 3 ,
|
||||
.Xr ck_ht_remove_spmc 3 ,
|
||||
.Xr ck_ht_count 3 ,
|
||||
.Xr ck_ht_reset 3 ,
|
||||
.Xr ck_ht_entry_empty 3 ,
|
||||
.Xr ck_ht_entry_key_set 3 ,
|
||||
.Xr ck_ht_entry_key_set_direct 3 ,
|
||||
.Xr ck_ht_entry_key_length 3 ,
|
||||
.Xr ck_ht_entry_key 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/
|
||||
@ -0,0 +1,86 @@
|
||||
.\"
|
||||
.\" Copyright 2012 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_VALUE_DIRECT 3
|
||||
.Sh NAME
|
||||
.Nm ck_ht_entry_value_direct
|
||||
.Nd return value as specified in hash table entry
|
||||
.Sh LIBRARY
|
||||
Concurrency Kit (libck, \-lck)
|
||||
.Sh SYNOPSIS
|
||||
.In ck_ht.h
|
||||
.Ft uintptr_t
|
||||
.Fn ck_ht_entry_value_direct "ck_ht_entry_t *entry"
|
||||
.Sh 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.
|
||||
.Pp
|
||||
It is expected that the entry is
|
||||
associated with a hash table initialized with
|
||||
.Dv CK_HT_MODE_DIRECT
|
||||
(see
|
||||
.Xr ck_ht_init 3
|
||||
for more information).
|
||||
.Sh RETURN VALUES
|
||||
The
|
||||
.Fn ck_ht_entry_value_direct
|
||||
function returns the value pointed to by
|
||||
.Dv entry.
|
||||
.Sh ERRORS
|
||||
Behavior is undefined if
|
||||
.Fa entry
|
||||
has not been initialized or if the key is empty.
|
||||
.Sh SEE ALSO
|
||||
.Xr ck_ht_init 3 ,
|
||||
.Xr ck_ht_destroy 3 ,
|
||||
.Xr ck_ht_allocator_set 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_get_spmc 3 ,
|
||||
.Xr ck_ht_grow_spmc 3 ,
|
||||
.Xr ck_ht_remove_spmc 3 ,
|
||||
.Xr ck_ht_count 3 ,
|
||||
.Xr ck_ht_reset 3 ,
|
||||
.Xr ck_ht_entry_empty 3 ,
|
||||
.Xr ck_ht_entry_key_set 3 ,
|
||||
.Xr ck_ht_entry_key_set_direct 3 ,
|
||||
.Xr ck_ht_entry_key_length 3 ,
|
||||
.Xr ck_ht_entry_key 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 3 ,
|
||||
.Xr ck_ht_iterator_init 3 ,
|
||||
.Xr ck_ht_next 3
|
||||
.Pp
|
||||
Additional information available at http://concurrencykit.org/
|
||||
Loading…
Reference in new issue