Adding upstream version 0.6.0.
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
parent
c49a9029dc
commit
7f70a05c55
465 changed files with 60158 additions and 0 deletions
71
doc/ck_epoch_poll
Normal file
71
doc/ck_epoch_poll
Normal file
|
@ -0,0 +1,71 @@
|
|||
.\"
|
||||
.\" 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_POLL 3
|
||||
.Sh NAME
|
||||
.Nm ck_epoch_poll
|
||||
.Nd non-blocking poll of epoch object for dispatch cycles
|
||||
.Sh LIBRARY
|
||||
Concurrency Kit (libck, \-lck)
|
||||
.Sh SYNOPSIS
|
||||
.In ck_epoch.h
|
||||
.Ft bool
|
||||
.Fn ck_epoch_poll "ck_epoch_record_t *record"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Fn ck_epoch_poll 3
|
||||
function will attempt to dispatch any functions associated with the
|
||||
object pointed to by
|
||||
.Fa epoch
|
||||
via
|
||||
.Fn ck_epoch_call 3
|
||||
if deemed safe. This function is meant to be used in cases epoch
|
||||
reclamation cost must be amortized over time in a manner that does
|
||||
not affect caller progress.
|
||||
.Sh RETURN VALUES
|
||||
This function will return true if at least one function was dispatched.
|
||||
This function will return false if it has determined not all threads have
|
||||
observed the latest generation of epoch-protected objects. Neither value
|
||||
indicates an error.
|
||||
.Sh ERRORS
|
||||
Behavior is undefined if the object pointed to by
|
||||
.Fa record
|
||||
has not 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_synchronize 3 ,
|
||||
.Xr ck_epoch_reclaim 3 ,
|
||||
.Xr ck_epoch_barrier 3 ,
|
||||
.Xr ck_epoch_call 3 ,
|
||||
.Xr ck_epoch_begin 3 ,
|
||||
.Xr ck_epoch_end 3
|
||||
.Pp
|
||||
Additional information available at http://concurrencykit.org/
|
Loading…
Add table
Add a link
Reference in a new issue