Brendon Scheinman
12 years ago
parent
6441c90cfe
commit
6298e6f7b2
@ -0,0 +1,66 @@
|
||||
.\"
|
||||
.\" 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 March 9, 2013.
|
||||
.Dt CK_COHORT_TRYLOCK 3
|
||||
.Sh NAME
|
||||
.Nm CK_COHORT_TRYLOCK
|
||||
.Nd Try to acquire a cohort's locks
|
||||
.Sh LIBRARY
|
||||
Concurrency Kit (libck, \-lck)
|
||||
.Sh SYNOPSIS
|
||||
.In ck_cohort.h
|
||||
.Fn CK_COHORT_TRYLOCK "COHORT_NAME cohort_name" "COHORT *cohort" "void *global_trylock_context" \
|
||||
"void *local_trylock_context" "void *lock_unlock_context"
|
||||
.Sh DESCRIPTION
|
||||
This call attempts to acquire both the local and global (if necessary) locks from
|
||||
.Fa cohort . It can only be used with cohort types that were defined using the
|
||||
.Xr CK_COHORT_TRYLOCK_PROTOTYPE 3
|
||||
macro. The call will not block and will return a bool that will evaluate to true iff
|
||||
the cohort was successfully acquired.
|
||||
.Fa global_trylock_context
|
||||
will be passed as the second argument to the function that was provided as the
|
||||
.Fa global_trylock_method
|
||||
argument to CK_COHORT_TRYLOCK_PROTOTYPE if that method is called, and
|
||||
.Fa local_trylock_context
|
||||
will be passed to the function specified by
|
||||
.Fa local_trylock_method
|
||||
. If the global lock acquisition fails, then the cohort will immediately release its
|
||||
local lock as well, and
|
||||
.Fa local_unlock_context
|
||||
will be passed to the function specified by
|
||||
.Fa local_unlock_method
|
||||
when this call is made.
|
||||
.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_INIT 3 ,
|
||||
.Xr CK_COHORT_UNLOCK 3 ,
|
||||
.Pp
|
||||
Additional information available at http://concurrencykit.org/
|
||||
@ -0,0 +1,81 @@
|
||||
.\"
|
||||
.\" 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 March 9, 2013.
|
||||
.Dt CK_COHORT_TRYLOCK_PROTOTYPE 3
|
||||
.Sh NAME
|
||||
.Nm CK_COHORT_TRYLOCK_PROTOTYPE
|
||||
.Nd Define a cohort type with the given lock types
|
||||
.Sh LIBRARY
|
||||
Concurrency Kit (libck, \-lck)
|
||||
.Sh SYNOPSIS
|
||||
.In ck_cohort.h
|
||||
.Fn CK_COHORT_TRYLOCK_PROTOTYPE "COHORT_NAME cohort_name" "LOCK_FXN global_lock_method" \
|
||||
"LOCK_FXN global_unlock_method" "TRYLOCK_FXN global_trylock_method" \
|
||||
"LOCK_FXN local_lock_method" "LOCK_FXN local_unlock_method" "TRYLOCK_FXN local_trylock_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 CK_COHORT_TRYLOCK_PROTOTYPE macros to define any types
|
||||
they want to use. The CK_COHORT_TRYLOCK_PROTOTYPE macro takes the
|
||||
following arguments:
|
||||
.Pp
|
||||
.Fa COHORT_NAME 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 LOCK_FXN global_lock_method
|
||||
: The method that should be called to acquire the global lock
|
||||
.br
|
||||
.Fa LOCK_FXN global_unlock_method
|
||||
: The method that should be called to relinquish the global lock
|
||||
.br
|
||||
.Fa TRYLOCK_FXN global_trylock_method
|
||||
: The method that should be called to try to acquire the global lock.
|
||||
It should not block and return true iff the lock was successfully acquired.
|
||||
.br
|
||||
.Fa LOCK_FXN local_lock_method
|
||||
: The method that should be called to acquire the local lock
|
||||
.br
|
||||
.Fa LOCK_FXN local_unlock_method
|
||||
: The method that should be called to relinquish the local lock
|
||||
.br
|
||||
.Fa TRYLOCK_FXN local_trylock_method
|
||||
: The method that should be called to try to acquire the local lock.
|
||||
It should not block and return true iff the lock was successfully acquired.
|
||||
.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_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 ,
|
||||
.Pp
|
||||
Additional information available at http://concurrencykit.org/
|
||||
Loading…
Reference in new issue