|
|
|
|
.\"
|
|
|
|
|
.\" Copyright 2012-2013 Abel P. Mathew
|
|
|
|
|
.\" 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 July 16th, 2012
|
|
|
|
|
.Dt CK_BAG_ITERATOR_INIT 3
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm ck_bag_iterator_init
|
|
|
|
|
.Nd initialize a ck_bag_iterator
|
|
|
|
|
.Sh LIBRARY
|
|
|
|
|
Concurrency Kit (libck, \-lck)
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.In ck_bag.h
|
|
|
|
|
.Ft void
|
|
|
|
|
.Fn ck_bag_iterator_init "ck_bag_iterator_t *iterator, ck_bag_t *bag"
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.Fn ck_bag_iterator_init
|
|
|
|
|
function will initialize the object pointed to by the
|
|
|
|
|
.Fa iterator
|
|
|
|
|
argument.
|
|
|
|
|
.Pp
|
|
|
|
|
An iterator is used to iterate through the entries pointed to by the
|
|
|
|
|
.Fa bag
|
|
|
|
|
argument by using the
|
|
|
|
|
.Fn ck_bag_next
|
|
|
|
|
function.
|
|
|
|
|
.Sh ERRORS
|
|
|
|
|
Behavior is undefined if the ck_bag pointed to by the
|
|
|
|
|
.Fa bag
|
|
|
|
|
argument has not been initialized.
|
|
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr ck_bag_allocator_set(3),
|
|
|
|
|
.Xr ck_bag_block_next(3),
|
|
|
|
|
.Xr ck_bag_destroy(3),
|
|
|
|
|
.Xr ck_bag_iterator_init(3),
|
|
|
|
|
.Xr ck_bag_next(3),
|
|
|
|
|
.Xr ck_bag_remove_spmc(3),
|
|
|
|
|
.Xr ck_bag_block_count(3),
|
|
|
|
|
.Xr ck_bag_count(3),
|
|
|
|
|
.Xr ck_bag_init(3),
|
|
|
|
|
.Xr ck_bag_member_spmc(3),
|
|
|
|
|
.Xr ck_bag_put_spmc(3),
|
|
|
|
|
.Xr ck_bag_set_spmc(3)
|
|
|
|
|
.Pp
|
|
|
|
|
Additional information available at http://concurrencykit.org/
|
