[apple/libpthread.git] / man / 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$
.Dd February 19, 2011
.Dt PTHREAD_SIGMASK 3
.Os
.Sh NAME
.Nm pthread_sigmask
.Nd examine and/or change a thread's signal mask
.Sh SYNOPSIS
.In signal.h
.Ft int
.Fn pthread_sigmask "int how" "const sigset_t * restrict set" \
    "sigset_t * restrict oset"
.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
The
.Fn pthread_sigmask
function 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
f1a1da6c 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	.\"
2546420a A	28	.\" $FreeBSD$
	29	.Dd February 19, 2011
	30	.Dt PTHREAD_SIGMASK 3
f1a1da6c A	31	.Os
	32	.Sh NAME
	33	.Nm pthread_sigmask
	34	.Nd examine and/or change a thread's signal mask
	35	.Sh SYNOPSIS
	36	.In signal.h
	37	.Ft int
2546420a A	38	.Fn pthread_sigmask "int how" "const sigset_t * restrict set" \
2546420a A	39	"sigset_t * restrict oset"
f1a1da6c A	40	.Sh DESCRIPTION
	41	The
	42	.Fn pthread_sigmask
	43	function examines and/or changes the calling thread's signal mask.
	44	.Pp
	45	If
	46	.Fa set
	47	is not
	48	.Dv NULL ,
	49	it specifies a set of signals to be modified, and
	50	.Fa how
	51	specifies what to set the signal mask to:
	52	.Bl -tag -width SIG_UNBLOCK
	53	.It Dv SIG_BLOCK
	54	Union of the current mask and
	55	.Fa set .
	56	.It Dv SIG_UNBLOCK
	57	Intersection of the current mask and the complement of
	58	.Fa set .
	59	.It Dv SIG_SETMASK
	60	.Fa set .
	61	.El
	62	.Pp
	63	If
	64	.Fa oset
	65	is not NULL, the previous signal mask is stored in the location pointed to by
	66	.Fa oset .
	67	.Pp
	68	.Dv SIGKILL
	69	and
	70	.Dv SIGSTOP
	71	cannot be blocked, and will be silently ignored if included in the signal mask.
	72	.Sh RETURN VALUES
	73	If successful,
	74	.Fn pthread_sigmask
	75	returns 0.
	76	Otherwise, an error is returned.
	77	.Sh ERRORS
2546420a	78	The
f1a1da6c	79	.Fn pthread_sigmask
2546420a	80	function will fail if:
f1a1da6c A	81	.Bl -tag -width Er
	82	.It Bq Er EINVAL
	83	.Fa how
	84	is not one of the defined values.
	85	.El
	86	.Sh LEGACY SYNOPSIS
	87	.Fd #include <pthread.h>
	88	.Fd #include <signal.h>
	89	.Pp
	90	The include file
	91	.In pthread.h
	92	is necessary.
	93	.Sh SEE ALSO
	94	.Xr sigaction 2 ,
	95	.Xr sigpending 2 ,
	96	.Xr sigprocmask 2 ,
	97	.Xr sigsuspend 2 ,
	98	.Xr sigsetops 3 ,
	99	.Xr compat 5
	100	.Sh STANDARDS
	101	.Fn pthread_sigmask
	102	conforms to ISO/IEC 9945-1:1996 (``POSIX.1'')