xref: /netbsd-src/lib/libpthread/pthread_sigmask.3 (revision 001c68bd94f75ce9270b69227c4199fbf34ee396)
1.\" $NetBSD: pthread_sigmask.3,v 1.2 2003/06/08 06:44:34 thorpej Exp $
2.\"
3.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\" 3. Neither the name of The NetBSD Foundation nor the names of its
14.\"    contributors may be used to endorse or promote products derived
15.\"    from this software without specific prior written permission.
16.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
17.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
18.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
20.\" BE 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 BUSINESS
23.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26.\" POSSIBILITY OF SUCH DAMAGE.
27.\"
28.\" Copyright (C) 2000 Jason Evans <jasone@FreeBSD.org>.
29.\" All rights reserved.
30.\"
31.\" Redistribution and use in source and binary forms, with or without
32.\" modification, are permitted provided that the following conditions
33.\" are met:
34.\" 1. Redistributions of source code must retain the above copyright
35.\"    notice(s), this list of conditions and the following disclaimer as
36.\"    the first lines of this file unmodified other than the possible
37.\"    addition of one or more copyright notices.
38.\" 2. Redistributions in binary form must reproduce the above copyright
39.\"    notice(s), this list of conditions and the following disclaimer in
40.\"    the documentation and/or other materials provided with the
41.\"    distribution.
42.\"
43.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
44.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
45.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
46.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
47.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
48.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
49.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
50.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
51.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
52.\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
53.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
54.\"
55.\" $FreeBSD: src/lib/libpthread/man/pthread_sigmask.3,v 1.10 2002/09/16 19:29:29 mini Exp $
56.Dd January 30, 2003
57.Dt PTHREAD_SIGMASK 3
58.Os
59.Sh NAME
60.Nm pthread_sigmask
61.Nd examine and/or change a thread's signal mask
62.Sh LIBRARY
63.Lb libpthread
64.Sh SYNOPSIS
65.\" .In pthread.h
66.In signal.h
67.Ft int
68.Fn pthread_sigmask "int how" "const sigset_t *set" "sigset_t *oset"
69.Sh DESCRIPTION
70The
71.Fn pthread_sigmask
72function examines and/or changes the calling thread's signal mask.
73.Pp
74If
75.Fa set
76is not
77.Dv NULL ,
78it specifies a set of signals to be modified, and
79.Fa how
80specifies what to set the signal mask to:
81.Bl -tag -width SIG_UNBLOCK
82.It Dv SIG_BLOCK
83Union of the current mask and
84.Fa set .
85.It Dv SIG_UNBLOCK
86Intersection of the current mask and the complement of
87.Fa set .
88.It Dv SIG_SETMASK
89.Fa set .
90.El
91.Pp
92If
93.Fa oset
94is not NULL, the previous signal mask is stored in the location pointed to by
95.Fa oset .
96.Pp
97.Dv SIGKILL
98and
99.Dv SIGSTOP
100cannot be blocked, and will be silently ignored if included in the signal mask.
101.Sh RETURN VALUES
102If successful,
103.Fn pthread_sigmask
104returns 0.
105Otherwise, an error is returned.
106.Sh ERRORS
107.Fn pthread_sigmask
108shall fail if:
109.Bl -tag -width Er
110.It Bq Er EINVAL
111.Fa how
112is not one of the defined values.
113.El
114.Sh SEE ALSO
115.Xr sigaction 2 ,
116.Xr sigpending 2 ,
117.Xr sigprocmask 2 ,
118.Xr sigsuspend 2 ,
119.Xr sigsetops 3
120.Sh STANDARDS
121.Fn pthread_sigmask
122conforms to
123.St -p1003.1-96
124