diff options
Diffstat (limited to 'doc/CK_COHORT_PROTOTYPE')
-rw-r--r-- | doc/CK_COHORT_PROTOTYPE | 76 |
1 files changed, 0 insertions, 76 deletions
diff --git a/doc/CK_COHORT_PROTOTYPE b/doc/CK_COHORT_PROTOTYPE deleted file mode 100644 index 7a7b1a717f6e..000000000000 --- a/doc/CK_COHORT_PROTOTYPE +++ /dev/null @@ -1,76 +0,0 @@ -.\" -.\" Copyright 2013 Brendon Scheinman. -.\" 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 February 24, 2013. -.Dt CK_COHORT_PROTOTYPE 3 -.Sh NAME -.Nm CK_COHORT_PROTOTYPE -.Nd define cohort type with specified lock types -.Sh LIBRARY -Concurrency Kit (libck, \-lck) -.Sh SYNOPSIS -.In ck_cohort.h -.Fn CK_COHORT_PROTOTYPE "COHORT_NAME cohort_name" "TYPE global_lock_method" \ -"LOCK_FXN global_unlock_method" "LOCK_FXN local_lock_method" "LOCK_FXN local_unlock_method" -.Sh DESCRIPTION -The ck_cohort.h header file does not define any cohort types. Instead, the user must use -the CK_COHORT_PROTOTYPE or -.Xr CK_COHORT_TRYLOCK_PROTOTYPE 3 -macros to define any types they want to use. They must use CK_COHORT_TRYLOCK_PROTOTYPE -if they want their cohort type to support trylock operations. -The CK_COHORT_PROTOTYPE macro takes the following arguments: -.Pp -.Fa cohort_name -: An identifier used for this cohort type. This will have to be passed to each -of the other CK_COHORT macros. -.br -.Fa global_lock_method -: The method that should be called to acquire the global lock -.br -.Fa global_unlock_method -: The method that should be called to relinquish the global lock -.br -.Fa local_lock_method -: The method that should be called to acquire the local lock -.br -.Fa local_unlock_method -: The method that should be called to relinquish the local lock -.Pp -Instances of the defined cohort type can be declared as: -.br - CK_COHORT_INSTANCE(cohort_name) cohort; -.Sh SEE ALSO -.Xr ck_cohort 3 , -.Xr CK_COHORT_TRYLOCK_PROTOTYPE 3 , -.Xr CK_COHORT_INSTANCE 3 , -.Xr CK_COHORT_INITIALIZER 3 , -.Xr CK_COHORT_INIT 3 , -.Xr CK_COHORT_LOCK 3 , -.Xr CK_COHORT_UNLOCK 3 , -.Xr CK_COHORT_LOCKED 3 , -.Xr CK_COHORT_TRYLOCK 3 , -.Pp -Additional information available at http://concurrencykit.org/ |