diff options
Diffstat (limited to 'doc/ck_epoch_begin')
| -rw-r--r-- | doc/ck_epoch_begin | 73 |
1 files changed, 0 insertions, 73 deletions
diff --git a/doc/ck_epoch_begin b/doc/ck_epoch_begin deleted file mode 100644 index a44ecf878991..000000000000 --- a/doc/ck_epoch_begin +++ /dev/null @@ -1,73 +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 September 2, 2012 -.Dt CK_EPOCH_BEGIN 3 -.Sh NAME -.Nm ck_epoch_begin -.Nd begin epoch-protected segment of execution -.Sh LIBRARY -Concurrency Kit (libck, \-lck) -.Sh SYNOPSIS -.In ck_epoch.h -.Ft void -.Fn ck_epoch_begin "ck_epoch_record_t *record" "ck_epoch_section_t *section" -.Sh DESCRIPTION -The -.Fn ck_epoch_begin 3 -function will mark the beginning of an epoch-protected code section. -An epoch-protected code section is delimited by a call to the -.Fn ck_epoch_end 3 -function. Though recursion is allowed for epoch-protected sections, -recursive calls will be associated with the -.Fn ck_epoch_begin 3 -that is at the top of the call stack. If a section is passed, then -recursion on a record will cause the epoch to be refreshed on entry -of every protected section. -.Sh RETURN VALUES -This function has no return value. -.Sh ERRORS -The object pointed to by -.Fa epoch -must have been previously initiated via -.Fn ck_epoch_init 3 . -The object pointed to by -.Fa record -must have been previously registered via -.Fn ck_epoch_register 3 . -.Sh SEE ALSO -.Xr ck_epoch_init 3 , -.Xr ck_epoch_register 3 , -.Xr ck_epoch_unregister 3 , -.Xr ck_epoch_recycle 3 , -.Xr ck_epoch_poll 3 , -.Xr ck_epoch_synchronize 3 , -.Xr ck_epoch_reclaim 3 , -.Xr ck_epoch_barrier 3 , -.Xr ck_epoch_call 3 , -.Xr ck_epoch_end 3 -.Pp -Additional information available at http://concurrencykit.org/ |
