summaryrefslogtreecommitdiff
path: root/doc/ck_ring_capacity
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ck_ring_capacity')
-rw-r--r--doc/ck_ring_capacity58
1 files changed, 0 insertions, 58 deletions
diff --git a/doc/ck_ring_capacity b/doc/ck_ring_capacity
deleted file mode 100644
index 645b54baea69..000000000000
--- a/doc/ck_ring_capacity
+++ /dev/null
@@ -1,58 +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 April 20, 2013
-.Dt CK_RING_CAPACITY 3
-.Sh NAME
-.Nm ck_ring_capacity
-.Nd returns number of pointer slots in bounded FIFO
-.Sh LIBRARY
-Concurrency Kit (libck, \-lck)
-.Sh SYNOPSIS
-.In ck_ring.h
-.Ft unsigned int
-.Fn ck_ring_capacity "ck_ring_t *ring"
-.Sh DESCRIPTION
-The
-.Fn ck_ring_capacity 3
-function returns the number of pointers that can be
-held in the buffer pointed to by
-.Fa ring .
-Note that a ring can only hold
-.Fn ck_ring_capacity 3
-minus one entries at a time.
-.Sh SEE ALSO
-.Xr ck_ring_init 3 ,
-.Xr ck_ring_enqueue_spmc 3 ,
-.Xr ck_ring_dequeue_spmc 3 ,
-.Xr ck_ring_trydequeue_spmc 3 ,
-.Xr ck_ring_enqueue_spmc_size 3 ,
-.Xr ck_ring_dequeue_spsc 3 ,
-.Xr ck_ring_enqueue_spsc 3 ,
-.Xr ck_ring_enqueue_spsc_size 3 ,
-.Xr ck_ring_size 3
-.Pp
-Additional information available at http://concurrencykit.org/