xref: /freebsd/release/packages/ucl/libbegemot-all.ucl (revision df21a004be237a1dccd03c7b47254625eea62fa9)
1/*
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c)1996-2006 by Hartmut Brandt
5 *     All rights reserved.
6 *
7 * Author: harti@freebsd.org <Hartmut Brandt>
8 *
9 * Redistribution of this software and documentation and use in source and
10 * binary forms, with or without modification, are permitted provided that
11 * the following conditions are met:
12 *
13 * 1. Redistributions of source code or documentation must retain the above
14 *   copyright notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *   notice, this list of conditions and the following disclaimer in the
17 *   documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE AND DOCUMENTATION IS PROVIDED BY THE AUTHOR
20 * AND ITS CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
21 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
22 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
23 * THE AUTHOR OR ITS CONTRIBUTORS  BE LIABLE FOR ANY DIRECT, INDIRECT,
24 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
26 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
29 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32comment = "rpoll(3) interface for event-driven I/O"
33
34desc = <<EOD
35libbegemot provides rpoll(3), a simplified interface for handling event-driven
36I/O programming.
37
38Many programs need to read from several file descriptors at the same time.
39Typically in these programs one of select(2) or poll(2) is used.  These
40calls are however clumsy to use and the usage of one of these calls is
41probably not portable to other systems - not all systems support both calls.
42
43The rpoll(3) family of functions is designed to overcome these restrictions.
44They support the well known and understood technique of event driven
45programming and, in addition to select(2) and poll(2) also support timers.
46EOD
47
48annotations {
49	set = "optional,optional-jail"
50}
51