aboutsummaryrefslogtreecommitdiff
path: root/doc/ck_array_put_unique
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ck_array_put_unique')
-rw-r--r--doc/ck_array_put_unique67
1 files changed, 0 insertions, 67 deletions
diff --git a/doc/ck_array_put_unique b/doc/ck_array_put_unique
deleted file mode 100644
index bb355febce7e..000000000000
--- a/doc/ck_array_put_unique
+++ /dev/null
@@ -1,67 +0,0 @@
-.\"
-.\" Copyright 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 October 18, 2013
-.Dt CK_ARRAY_PUT_UNIQUE 3
-.Sh NAME
-.Nm ck_array_put_unique
-.Nd attempt immediate or deferred insertion of a unique pointer into array
-.Sh LIBRARY
-Concurrency Kit (libck, \-lck)
-.Sh SYNOPSIS
-.In ck_array.h
-.Ft int
-.Fn ck_array_put_unique "ck_array_t *array" "void *pointer"
-.Sh DESCRIPTION
-The
-.Fn ck_array_put_unique 3
-function will attempt to insert the value of
-.Fa pointer
-into the array pointed to by
-.Fa array .
-This function may incur additional memory allocations
-if not enough memory has been allocated in the array
-for a new entry. The operation is also free to apply
-the operation immediately if there is an opportunity
-for elimination with a pending (uncommitted) remove
-operation. The function will not make any modifications
-if the pointer already exists in the array.
-.Sh RETURN VALUES
-This function returns 1 if the pointer already exists in the array.
-It returns 0 if the put operation succeeded. It returns -1 on
-error due to internal memory allocation failures.
-.Sh SEE ALSO
-.Xr ck_array_init 3 ,
-.Xr ck_array_commit 3 ,
-.Xr ck_array_put 3 ,
-.Xr ck_array_remove 3 ,
-.Xr ck_array_deinit 3
-.Xr ck_array_length 3 ,
-.Xr ck_array_buffer 3 ,
-.Xr ck_array_initialized 3 ,
-.Xr CK_ARRAY_FOREACH 3
-.Pp
-Additional information available at http://concurrencykit.org/