usr/src/lib/libc/gen/sigsetops.3

.\" Copyright (c) 1983, 1991 The Regents of the University of California.
.\" 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.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"     This product includes software developed by the University of
.\"     California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" 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.
.\"
.\"     @(#)sigsetops.3 6.2 (Berkeley) 4/19/91
.\"
.Dd April 19, 1991
.Dt SIGSETOPS 3
.Os
.Sh NAME
.Nm sigsetops ,
.Nm sigemptyset ,
.Nm sigfillset ,
.Nm sigaddset ,
.Nm sigdelset ,
.Nm sigismember
.Nd manipulate signal masks
.Sh SYNOPSIS
.Fd #include <signal.h>
.Fn sigemptyset "sigset_t *set"
.Fn sigfillset "sigset_t *set"
.Fn sigaddset "sigset_t *set" "int signo"
.Fn sigdelset "sigset_t *set" "int signo"
.Fn sigismember "sigset_t *set" "int signo"
.Sh DESCRIPTION
These functions manipulate signal mask stored in a
.Fa sigset_t .
They are provided as macros, but actual functions are available
if their names are undefined (with #undef
.Em name ) .
.Pp
The
.Fn sigemptyset
function initializes a signal set to be empty.
The
.Fn sigfillset
function initializes a signal set to contain all of the known signals.
One of these routines must be used to initialize a signal set
before its use by the other functions.
.Pp
The
.Fn sigaddset
function adds a specified signal
.Fa signo
to a signal set.
The
.Fn sigdelset
function deletes a specified signal
.Fa signo
from a signal set.
.Pp
The
.Fn sigismember
function tests whether a specified signal
.Fa signo
is contained in a signal set.
.Sh RETURN VALUES
The
.Fn sigismember
function returnes 1
if the signal is a member of the set,
a 0 otherwise.
The other functions return 0 upon success.
A \-1 return value
indicates an error occurred and the global variable
.Va errno
is set to indicated the reason.
The current implementation does not detect any errors.
.Sh ERRORS
These functions could fail if one of the following occurs:
.Bl -tag -width [EINVAL]
.It Bq Er EINVAL
.Fa signo
has an invalid value.
.El
.Sh SEE ALSO
.Xr kill 2 ,
.Xr sigaction 2 ,
.Xr sigsetops 2 ,
.Xr sigsuspend 2
.Sh STANDARDS
The
These functions are defined by
.St -p1003.1-88 .
.Sh HISTORY
These functions are
.Ud .