|
|
|
|
.\"
|
|
|
|
|
.\" 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_INIT 3
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm CK_COHORT_INIT
|
|
|
|
|
.Nd Initialize an instance of a cohort type
|
|
|
|
|
.Sh LIBRARY
|
|
|
|
|
Concurrency Kit (libck, \-lck)
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.In ck_cohort.h
|
|
|
|
|
.Fn CK_COHORT_INIT "COHORT_NAME cohort_name" "COHORT *cohort" "void *global_lock" \
|
|
|
|
|
"void *local_lock" "unsigned int pass_limit"
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
Until a cohort instance is initialized using the CK_COHORT_INIT macro, any operations
|
|
|
|
|
involving it will have undefined behavior. After this macro has been called, the cohort
|
|
|
|
|
pointed to by the
|
|
|
|
|
.Fa cohort
|
|
|
|
|
argument will use the lock pointed to by
|
|
|
|
|
.Fa global_lock
|
|
|
|
|
as its global lock and the lock pointed to by
|
|
|
|
|
.Fa local_lock
|
|
|
|
|
as its local lock.
|
|
|
|
|
.Pp
|
|
|
|
|
The cohort will relinquish its global lock after
|
|
|
|
|
.Fa pass_limit
|
|
|
|
|
consecutive acquisitions of its local lock, even if there are other threads waiting.
|
|
|
|
|
If you are unsure of a value to use for the
|
|
|
|
|
.Fa pass_limit
|
|
|
|
|
argument, you should use CK_COHORT_DEFAULT_LOCAL_PASS_LIMIT.
|
|
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr ck_cohort 3 ,
|
|
|
|
|
.Xr CK_COHORT_PROTOTYPE 3 ,
|
|
|
|
|
.Xr CK_COHORT_TRYLOCK_PROTOTYPE 3 ,
|
|
|
|
|
.Xr CK_COHORT_INSTANCE 3 ,
|
|
|
|
|
.Xr CK_COHORT_INITIALIZER 3 ,
|
|
|
|
|
.Xr CK_COHORT_LOCK 3 ,
|
|
|
|
|
.Xr CK_COHORT_UNLOCK 3 ,
|
|
|
|
|
.Xr CK_COHORT_TRYLOCK 3 ,
|
|
|
|
|
.Pp
|
|
|
|
|
Additional information available at http://concurrencykit.org/
|
