[apple/libc.git] / sys / pthread_sigmask.2

.\" Copyright (C) 2000 Jason Evans <jasone@FreeBSD.org>.
.\" 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(s), this list of conditions and the following disclaimer as
.\"    the first lines of this file unmodified other than the possible
.\"    addition of one or more copyright notices.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice(s), 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 COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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.
.\"
.\" $FreeBSD: src/lib/libc_r/man/pthread_sigmask.3,v 1.9 2001/10/01 16:09:09 ru Exp $
.Dd April 27, 2000
.Dt PTHREAD_SIGMASK 2
.Os
.Sh NAME
.Nm pthread_sigmask
.Nd examine and/or change a thread's signal mask
.Sh SYNOPSIS
.In signal.h
.Ft int
.Fo pthread_sigmask
.Fa "int how"
.Fa "const sigset_t *restrict set"
.Fa "sigset_t *restrict oset"
.Fc
.Sh DESCRIPTION
The
.Fn pthread_sigmask
function examines and/or changes the calling thread's signal mask.
.Pp
If
.Fa set
is not
.Dv NULL ,
it specifies a set of signals to be modified, and
.Fa how
specifies what to set the signal mask to:
.Bl -tag -width SIG_UNBLOCK
.It Dv SIG_BLOCK
Union of the current mask and
.Fa set .
.It Dv SIG_UNBLOCK
Intersection of the current mask and the complement of
.Fa set .
.It Dv SIG_SETMASK
.Fa set .
.El
.Pp
If
.Fa oset
is not NULL, the previous signal mask is stored in the location pointed to by
.Fa oset .
.Pp
.Dv SIGKILL
and
.Dv SIGSTOP
cannot be blocked, and will be silently ignored if included in the signal mask.
.Sh RETURN VALUES
If successful,
.Fn pthread_sigmask
returns 0.
Otherwise, an error is returned.
.Sh ERRORS
.Fn pthread_sigmask
will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
.Fa how
is not one of the defined values.
.El
.Sh LEGACY SYNOPSIS
.Fd #include <pthread.h>
.Fd #include <signal.h>
.Pp
The include file
.In pthread.h
is necessary.
.Sh SEE ALSO
.Xr sigaction 2 ,
.Xr sigpending 2 ,
.Xr sigprocmask 2 ,
.Xr sigsuspend 2 ,
.Xr sigsetops 3 ,
.Xr compat 5
.Sh STANDARDS
.Fn pthread_sigmask
conforms to ISO/IEC 9945-1:1996 (``POSIX.1'')
Commit	Line	Data
5b2abdfb A	1	.\" Copyright (C) 2000 Jason Evans <jasone@FreeBSD.org>.
	2	.\" All rights reserved.
	3	.\"
	4	.\" Redistribution and use in source and binary forms, with or without
	5	.\" modification, are permitted provided that the following conditions
	6	.\" are met:
	7	.\" 1. Redistributions of source code must retain the above copyright
	8	.\" notice(s), this list of conditions and the following disclaimer as
	9	.\" the first lines of this file unmodified other than the possible
	10	.\" addition of one or more copyright notices.
	11	.\" 2. Redistributions in binary form must reproduce the above copyright
	12	.\" notice(s), this list of conditions and the following disclaimer in
	13	.\" the documentation and/or other materials provided with the
	14	.\" distribution.
	15	.\"
	16	.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
	17	.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	18	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
	19	.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
	20	.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
	21	.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
	22	.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
	23	.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
	24	.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
	25	.\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
	26	.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	27	.\"
	28	.\" $FreeBSD: src/lib/libc_r/man/pthread_sigmask.3,v 1.9 2001/10/01 16:09:09 ru Exp $
	29	.Dd April 27, 2000
	30	.Dt PTHREAD_SIGMASK 2
	31	.Os
	32	.Sh NAME
	33	.Nm pthread_sigmask
	34	.Nd examine and/or change a thread's signal mask
	35	.Sh SYNOPSIS
5b2abdfb A	36	.In signal.h
5b2abdfb A	37	.Ft int
224c7076 A	38	.Fo pthread_sigmask
	39	.Fa "int how"
	40	.Fa "const sigset_t *restrict set"
	41	.Fa "sigset_t *restrict oset"
	42	.Fc
5b2abdfb A	43	.Sh DESCRIPTION
	44	The
	45	.Fn pthread_sigmask
	46	function examines and/or changes the calling thread's signal mask.
	47	.Pp
	48	If
	49	.Fa set
	50	is not
	51	.Dv NULL ,
	52	it specifies a set of signals to be modified, and
	53	.Fa how
	54	specifies what to set the signal mask to:
	55	.Bl -tag -width SIG_UNBLOCK
	56	.It Dv SIG_BLOCK
	57	Union of the current mask and
	58	.Fa set .
	59	.It Dv SIG_UNBLOCK
	60	Intersection of the current mask and the complement of
	61	.Fa set .
	62	.It Dv SIG_SETMASK
	63	.Fa set .
	64	.El
	65	.Pp
	66	If
	67	.Fa oset
	68	is not NULL, the previous signal mask is stored in the location pointed to by
	69	.Fa oset .
	70	.Pp
	71	.Dv SIGKILL
	72	and
	73	.Dv SIGSTOP
	74	cannot be blocked, and will be silently ignored if included in the signal mask.
	75	.Sh RETURN VALUES
	76	If successful,
	77	.Fn pthread_sigmask
	78	returns 0.
	79	Otherwise, an error is returned.
	80	.Sh ERRORS
	81	.Fn pthread_sigmask
	82	will fail if:
	83	.Bl -tag -width Er
	84	.It Bq Er EINVAL
	85	.Fa how
	86	is not one of the defined values.
	87	.El
224c7076 A	88	.Sh LEGACY SYNOPSIS
	89	.Fd #include <pthread.h>
	90	.Fd #include <signal.h>
	91	.Pp
	92	The include file
	93	.In pthread.h
	94	is necessary.
5b2abdfb A	95	.Sh SEE ALSO
	96	.Xr sigaction 2 ,
	97	.Xr sigpending 2 ,
	98	.Xr sigprocmask 2 ,
	99	.Xr sigsuspend 2 ,
224c7076 A	100	.Xr sigsetops 3 ,
224c7076 A	101	.Xr compat 5
5b2abdfb A	102	.Sh STANDARDS
	103	.Fn pthread_sigmask
	104	conforms to ISO/IEC 9945-1:1996 (``POSIX.1'')