68 lines
2.5 KiB
Text
68 lines
2.5 KiB
Text
|
.\"
|
||
|
|
.\" 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_REGISTER 3
|
||
|
|
.Sh NAME
|
||
|
|
.Nm ck_epoch_register
|
||
|
|
.Nd register a thread for epoch reclamation
|
||
|
|
.Sh LIBRARY
|
||
|
|
Concurrency Kit (libck, \-lck)
|
||
|
|
.Sh SYNOPSIS
|
||
|
|
.In ck_epoch.h
|
||
|
|
.Ft void
|
||
|
|
.Fn ck_epoch_register "ck_epoch_t *epoch" "ck_epoch_record_t *record"
|
||
|
|
.Sh DESCRIPTION
|
||
|
|
The
|
||
|
|
.Fn ck_epoch_register 3
|
||
|
|
function associates a record object specified by the
|
||
|
|
.Fa record
|
||
|
|
pointer with the epoch object pointed to by
|
||
|
|
.Fa epoch .
|
||
|
|
Any thread or processor that will require safe memory reclamation
|
||
|
|
guarantees must register a unique record object. After registration, the
|
||
|
|
object pointed to by the
|
||
|
|
.Fa record
|
||
|
|
argument will have lifetime managed by the underlying epoch sub-system.
|
||
|
|
The record object must not be destroyed after it is associated with a
|
||
|
|
.Fn ck_epoch_register 3
|
||
|
|
call.
|
||
|
|
.Sh RETURN VALUES
|
||
|
|
This function has no return value.
|
||
|
|
.Sh SEE ALSO
|
||
|
|
.Xr ck_epoch_init 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_begin 3 ,
|
||
|
|
.Xr ck_epoch_end 3
|
||
|
|
.Pp
|
||
|
|
Additional information available at http://concurrencykit.org/
|