xref: /freebsd/share/man/man3/pthread_sigmask.3 (revision 5521ff5a4d1929056e7ffc982fac3341ca54df7c)
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$
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 <pthread.h>
39.Fd #include <signal.h>
40.Ft int
41.Fn pthread_sigmask "int how" "const sigset_t *set" "sigset_t *oset"
42.Sh DESCRIPTION
43The
44.Fn pthread_sigmask
45function examines and/or changes the calling thread's signal mask.
46.Pp
47If
48.Fa set
49is not
50.Dv NULL ,
51it specifies a set of signals to be modified, and
52.Fa how
53specifies what to set the signal mask to:
54.Bl -tag -width SIG_UNBLOCK
55.It Dv SIG_BLOCK
56Union of the current mask and
57.Fa set .
58.It Dv SIG_UNBLOCK
59Intersection of the current mask and the complement of
60.Fa set .
61.It Dv SIG_SETMASK
62.Fa set .
63.El
64.Pp
65If
66.Fa oset
67is not NULL, the previous signal mask is stored in the location pointed to by
68.Fa oset .
69.Pp
70.Dv SIGKILL
71and
72.Dv SIGSTOP
73cannot be blocked, and will be silently ignored if included in the signal mask.
74.Sh RETURN VALUES
75If successful,
76.Fn pthread_sigmask
77returns 0.
78Otherwise, an error is returned.
79.Sh ERRORS
80.Fn pthread_sigmask
81will fail if:
82.Bl -tag -width Er
83.It Bq Er EINVAL
84.Fa how
85is not one of the defined values.
86.El
87.Sh SEE ALSO
88.Xr sigaction 2 ,
89.Xr sigpending 2 ,
90.Xr sigprocmask 2 ,
91.Xr sigsuspend 2 ,
92.Xr sigsetops 3
93.Sh STANDARDS
94.Fn pthread_sigmask
95conforms to
96.St -p1003.1-96
97