haiwan
/
ck
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

ck_cohort: Cleaned up documentation changes

Browse Source
ck_pring
Brendon Scheinman 12 years ago
parent 6298e6f7b2
commit 91ef0220c7
4 changed files with 23 additions and 20 deletions
Show Stats Download Patch File Download Diff File

15
doc/CK_COHORT_PROTOTYPE
Unescape View File

@ -39,23 +39,24 @@ Concurrency Kit (libck, \-lck)
The ck_cohort.h header file does not define any cohort types. Instead, the user must use The ck_cohort.h header file does not define any cohort types. Instead, the user must use
the CK_COHORT_PROTOTYPE or the CK_COHORT_PROTOTYPE or
.Xr CK_COHORT_TRYLOCK_PROTOTYPE 3 .Xr CK_COHORT_TRYLOCK_PROTOTYPE 3
macros to define any types they want to use. The CK_COHORT_PROTOTYPE macro takes the macros to define any types they want to use. They must use CK_COHORT_TRYLOCK_PROTOTYPE
following arguments: if they want their cohort type to support trylock operations.
The CK_COHORT_PROTOTYPE macro takes the following arguments:
.Pp .Pp
.Fa COHORT_NAME cohort_name .Fa cohort_name
: An identifier used for this cohort type. This will have to be passed to each : An identifier used for this cohort type. This will have to be passed to each
of the other CK_COHORT macros. of the other CK_COHORT macros.
.br .br
.Fa LOCK_FXN global_lock_method .Fa global_lock_method
: The method that should be called to acquire the global lock : The method that should be called to acquire the global lock
.br .br
.Fa LOCK_FXN global_unlock_method .Fa global_unlock_method
: The method that should be called to relinquish the global lock : The method that should be called to relinquish the global lock
.br .br
.Fa LOCK_FXN local_lock_method .Fa local_lock_method
: The method that should be called to acquire the local lock : The method that should be called to acquire the local lock
.br .br
.Fa LOCK_FXN local_unlock_method .Fa local_unlock_method
: The method that should be called to relinquish the local lock : The method that should be called to relinquish the local lock
.Pp .Pp
Instances of the defined cohort type can be declared as: Instances of the defined cohort type can be declared as:

7
doc/CK_COHORT_TRYLOCK
Unescape View File

@ -37,7 +37,8 @@ Concurrency Kit (libck, \-lck)
"void *local_trylock_context" "void *lock_unlock_context" "void *local_trylock_context" "void *lock_unlock_context"
.Sh DESCRIPTION .Sh DESCRIPTION
This call attempts to acquire both the local and global (if necessary) locks from 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 .Fa cohort .
It can only be used with cohort types that were defined using the
.Xr CK_COHORT_TRYLOCK_PROTOTYPE 3 .Xr CK_COHORT_TRYLOCK_PROTOTYPE 3
macro. The call will not block and will return a bool that will evaluate to true iff macro. The call will not block and will return a bool that will evaluate to true iff
the cohort was successfully acquired. the cohort was successfully acquired.
@ -47,8 +48,8 @@ will be passed as the second argument to the function that was provided as the
argument to CK_COHORT_TRYLOCK_PROTOTYPE if that method is called, and argument to CK_COHORT_TRYLOCK_PROTOTYPE if that method is called, and
.Fa local_trylock_context .Fa local_trylock_context
will be passed to the function specified by will be passed to the function specified by
.Fa local_trylock_method .Fa local_trylock_method .
. If the global lock acquisition fails, then the cohort will immediately release its If the global lock acquisition fails, then the cohort will immediately release its
local lock as well, and local lock as well, and
.Fa local_unlock_context .Fa local_unlock_context
will be passed to the function specified by will be passed to the function specified by

19
doc/CK_COHORT_TRYLOCK_PROTOTYPE
Unescape View File

@ -39,30 +39,31 @@ Concurrency Kit (libck, \-lck)
.Sh DESCRIPTION .Sh DESCRIPTION
The ck_cohort.h header file does not define any cohort types. Instead, the user must use 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 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 they want to use.
following arguments: They must use CK_COHORT_TRYLOCK_PROTOTYPE if they want their cohort type to have support
for trylock operations. The CK_COHORT_TRYLOCK_PROTOTYPE macro takes the following arguments:
.Pp .Pp
.Fa COHORT_NAME cohort_name .Fa cohort_name
: An identifier used for this cohort type. This will have to be passed to each : An identifier used for this cohort type. This will have to be passed to each
of the other CK_COHORT macros. of the other CK_COHORT macros.
.br .br
.Fa LOCK_FXN global_lock_method .Fa global_lock_method
: The method that should be called to acquire the global lock : The method that should be called to acquire the global lock
.br .br
.Fa LOCK_FXN global_unlock_method .Fa global_unlock_method
: The method that should be called to relinquish the global lock : The method that should be called to relinquish the global lock
.br .br
.Fa TRYLOCK_FXN global_trylock_method .Fa global_trylock_method
: The method that should be called to try to acquire the global lock. : 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. It should not block and return true iff the lock was successfully acquired.
.br .br
.Fa LOCK_FXN local_lock_method .Fa local_lock_method
: The method that should be called to acquire the local lock : The method that should be called to acquire the local lock
.br .br
.Fa LOCK_FXN local_unlock_method .Fa local_unlock_method
: The method that should be called to relinquish the local lock : The method that should be called to relinquish the local lock
.br .br
.Fa TRYLOCK_FXN local_trylock_method .Fa local_trylock_method
: The method that should be called to try to acquire the local lock. : 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. It should not block and return true iff the lock was successfully acquired.
.Pp .Pp

Write Preview
Loading…
Cancel
Save