]> git.saurik.com Git - apple/libc.git/blame - sys/pthread_sigmask.2
Libc-391.5.22.tar.gz
[apple/libc.git] / sys / pthread_sigmask.2
CommitLineData
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
36.In pthread.h
37.In signal.h
38.Ft int
39.Fn pthread_sigmask "int how" "const sigset_t *set" "sigset_t *oset"
40.Sh DESCRIPTION
41The
42.Fn pthread_sigmask
43function examines and/or changes the calling thread's signal mask.
44.Pp
45If
46.Fa set
47is not
48.Dv NULL ,
49it specifies a set of signals to be modified, and
50.Fa how
51specifies what to set the signal mask to:
52.Bl -tag -width SIG_UNBLOCK
53.It Dv SIG_BLOCK
54Union of the current mask and
55.Fa set .
56.It Dv SIG_UNBLOCK
57Intersection of the current mask and the complement of
58.Fa set .
59.It Dv SIG_SETMASK
60.Fa set .
61.El
62.Pp
63If
64.Fa oset
65is not NULL, the previous signal mask is stored in the location pointed to by
66.Fa oset .
67.Pp
68.Dv SIGKILL
69and
70.Dv SIGSTOP
71cannot be blocked, and will be silently ignored if included in the signal mask.
72.Sh RETURN VALUES
73If successful,
74.Fn pthread_sigmask
75returns 0.
76Otherwise, an error is returned.
77.Sh ERRORS
78.Fn pthread_sigmask
79will fail if:
80.Bl -tag -width Er
81.It Bq Er EINVAL
82.Fa how
83is not one of the defined values.
84.El
85.Sh SEE ALSO
86.Xr sigaction 2 ,
87.Xr sigpending 2 ,
88.Xr sigprocmask 2 ,
89.Xr sigsuspend 2 ,
90.Xr sigsetops 3
91.Sh STANDARDS
92.Fn pthread_sigmask
93conforms to ISO/IEC 9945-1:1996 (``POSIX.1'')