xref: /freebsd/share/man/man3/pthread_sigmask.3 (revision 4c089f4dffe2205b8c8833d43180fbde6d42d9e7)
1.\" Copyright (C) 2000 Jason Evans <jasone@canonware.com>.
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$
29.Dd April 27, 2000
30.Dt PTHREAD_SIGMASK 3
31.Os
32.Sh NAME
33.Nm pthread_sigmask
34.Nd examine and/or change a thread's signal mask
35.Sh LIBRARY
36.Lb libc_r
37.Sh SYNOPSIS
38.Fd #include <signal.h>
39.Ft int
40.Fn pthread_sigmask "int how" "const sigset_t *set" "sigset_t *oset"
41.Sh DESCRIPTION
42The
43.Fn pthread_sigmask
44function examines and/or changes the calling thread's signal mask.
45.Pp
46If
47.Fa set
48is not
49.Dv NULL ,
50it specifies a set of signals to be modified, and
51.Fa how
52specifies what to set the signal mask to:
53.Bl -tag -width SIG_UNBLOCK
54.It Dv SIG_BLOCK
55Union of the current mask and
56.Fa set .
57.It Dv SIG_UNBLOCK
58Intersection of the current mask and the complement of
59.Fa set .
60.It Dv SIG_SETMASK
61.Fa set .
62.El
63.Pp
64If
65.Fa oset
66is not NULL, the previous signal mask is stored in the location pointed to by
67.Fa oset .
68.Pp
69.Dv SIGKILL
70and
71.Dv SIGSTOP
72cannot be blocked, and will be silently ignored if included in the signal mask.
73.Sh RETURN VALUES
74If successful,
75.Fn pthread_sigmask
76returns 0.
77Otherwise, an error is returned.
78.Sh ERRORS
79.Fn pthread_sigmask
80will fail if:
81.Bl -tag -width Er
82.It Bq Er EINVAL
83.Fa how
84is not one of the defined values.
85.El
86.Sh SEE ALSO
87.Xr sigaction 2 ,
88.Xr sigpending 2 ,
89.Xr sigprocmask 2 ,
90.Xr sigsetops 3 ,
91.Xr sigsuspend 2
92.Sh STANDARDS
93.Fn pthread_sigmask
94conforms to ISO/IEC 9945-1 ANSI/IEEE
95.Pq Dq Tn POSIX
96Std 1003.1 1996 Edition.
97